Skip to main content

Uniphore Customer Portal

Search Keywords/Phrases in Transcripts

This API helps to search the given keywords/phrases in the transcript of the contacts within the given date range for the specific category and organization. It filters the list of calls matching with the given keyword and fetches the information about word cloud and count of the corresponding calls.

  • External System can provide the keywords/phrases to be searched in the transcript, category ID, start time and end time as input parameters. These parameters are required.

  • After successful authentication, this API sends the metadata information of those transcripts as response.

Endpoint

Method: GET

URL: http://host:port/search?q=<searchtext>&categoryIds=<ids>&organizationId=<id>&startTime=<epoch-time>&endTime=<epoch-time>

Header Parameter

Authorization- Bearer <Token>

Query Parameters

Parameter name

Mandatory / Optional

Type

Description

search-text

Mandatory

string

Text to be searched within the specific category and organization

organizationId

Mandatory

string

Organization ID in which text search to be performed

startTime

Mandatory

long

Beginning date range for the search

endTime

Mandatory

long

Ending date range for the search

categoryIds

Optional

string

Category ID in which text search to be performed

agentIds

Optional

string

List of agent IDs to search

contactTypes

Optional

string

List of contact types (example: voice, email, chat) to search

clientContactIds

Optional

string

List of client contact IDs to search

customerId

Optional

string

Customer ID to search

externalMetadata

Optional

string

A map of externalMetadata to search (example: 1234=agent1,agent2;1235=5105790001)

Example Request
curl --location --request GET 'http://host:port/search?q=<search-text>&categoryIds=<ids>&organizationId=9&startTime=<epoch-time>&endTime=<epoch-time>' \
--header 'Authorization: Bearer 1234567890'
Example Response
event:28
data:{"_id":"6172a44263ada8c0a831aeb2","sessionId":"28","lang":"en-us","searchLang":"en","startTime":1612001410000,"metadata":{"agentId":"3","organizationId":"9","tenantId":"1","customerId":"3","contactId":"3a096d08-8474-4233-b66b-3735030ee396","categoryId":"11","type":"batch","contactType":"voice","convId":"smokestereo31jan8","journeyId":"journeysmokestereo8jan","isDiarized":true,"contactDuration":220502,"agentClientId":"Agent1","customerClientId":"Client1"},"isChunk":false,"isLastChunk":true,"__ts":0}

event:23
data:{"_id":"6172a2a163ada8c0a831a73e","sessionId":"23","lang":"en-us","searchLang":"en","startTime":1612001410000,"metadata":{"agentId":"3","organizationId":"9","tenantId":"1","customerId":"3","contactId":"bb467266-f826-4d1b-a5b9-35bdcbc1b8b8","categoryId":"11","type":"batch","contactType":"voice","convId":"smokestereo31jan3","journeyId":"journeysmokestereo31jan3","isDiarized":true,"contactDuration":205382,"agentClientId":"Agent1","customerClientId":"Client1"},"isChunk":false,"isLastChunk":true,"__ts":0}

event:21
data:{"_id":"6172a2a463ada8c0a831a764","sessionId":"21","lang":"en-us","searchLang":"en","startTime":1612001410000,"metadata":{"agentId":"3","organizationId":"9","tenantId":"1","customerId":"3","contactId":"58df523c-3c98-4dad-b854-b6fbf85f1bad","categoryId":"11","type":"batch","contactType":"voice","convId":"smokestereo31jan1","journeyId":"journeysmokestereo31jan1","isDiarized":true,"contactDuration":211462,"agentClientId":"Agent1","customerClientId":"Client1"},"isChunk":false,"isLastChunk":true,"__ts":0}

event:22
data:{"_id":"6172a28363ada8c0a831a69d","sessionId":"22","lang":"en-us","searchLang":"en","startTime":1612001410000,"metadata":{"agentId":"3","organizationId":"9","tenantId":"1","customerId":"3","contactId":"93d42aca-e28d-4d32-aa1c-77d455ae7313","categoryId":"11","type":"batch","contactType":"voice","convId":"smokestereo31jan2","journeyId":"journeysmokestereo31jan2","isDiarized":true,"contactDuration":183202,"agentClientId":"Agent1","customerClientId":"Client1"},"isChunk":false,"isLastChunk":true,"__ts":0}

event:30
data:{"_id":"6172a47263ada8c0a831afb2","sessionId":"30","lang":"en-us","searchLang":"en","startTime":1612001410000,"metadata":{"agentId":"3","organizationId":"9","tenantId":"1","customerId":"3","contactId":"58d8c32d-2356-4149-a541-d1daae1a4868","categoryId":"11","type":"batch","contactType":"voice","convId":"smokestereo31jan10","journeyId":"journeysmokestereo31jan10","isDiarized":true,"contactDuration":221502,"agentClientId":"Agent1","customerClientId":"Client1"},"isChunk":false,"isLastChunk":true,"__ts":0}

event:26
data:{"_id":"6172a2c763ada8c0a831a814","sessionId":"26","lang":"en-us","searchLang":"en","startTime":1612001410000,"metadata":{"agentId":"3","organizationId":"9","tenantId":"1","customerId":"3","contactId":"f84415f1-b7db-4545-8af1-0660a6854fee","categoryId":"11","type":"batch","contactType":"voice","convId":"smokestereo31jan6","journeyId":"journeysmokestereo31jan6","isDiarized":true,"contactDuration":222802,"agentClientId":"Agent1","customerClientId":"Client1"},"isChunk":false,"isLastChunk":true,"__ts":0}

event:29
data:{"_id":"6172a45b63ada8c0a831af37","sessionId":"29","lang":"en-us","searchLang":"en","startTime":1612001410000,"metadata":{"agentId":"3","organizationId":"9","tenantId":"1","customerId":"3","contactId":"b1d51d22-1fca-4d2f-9e87-eb58c0eff982","categoryId":"11","type":"batch","contactType":"voice","convId":"smokestereo31jan9","journeyId":"journeysmokestereo31jan9","isDiarized":true,"contactDuration":217242,"agentClientId":"Agent1","customerClientId":"Client1"},"isChunk":false,"isLastChunk":true,"__ts":0}

event:27
data:{"_id":"6172a42f63ada8c0a831ae54","sessionId":"27","lang":"en-us","searchLang":"en","startTime":1612001410000,"metadata":{"agentId":"3","organizationId":"9","tenantId":"1","customerId":"3","contactId":"17845f2f-8994-487a-a234-1b52950048c7","categoryId":"11","type":"batch","contactType":"voice","convId":"smokestereo31jan7","journeyId":"journeysmokestereo31jan9","isDiarized":true,"contactDuration":217242,"agentClientId":"Agent1","customerClientId":"Client1"},"isChunk":false,"isLastChunk":true,"__ts":0}

event:24
data:{"_id":"6172a28363ada8c0a831a6b0","sessionId":"24","lang":"en-us","searchLang":"en","startTime":1612001410000,"metadata":{"agentId":"3","organizationId":"9","tenantId":"1","customerId":"3","contactId":"4679071e-44b8-4e35-9985-eb08690a10c8","categoryId":"11","type":"batch","contactType":"voice","convId":"smokestereo31jan4","journeyId":"journeysmokestereo31jan4","isDiarized":true,"contactDuration":209462,"agentClientId":"Agent1","customerClientId":"Client1"},"isChunk":false,"isLastChunk":true,"__ts":0}

event:Wordcount
data:{"'s":6,"-":1,".com":6,"0531":1,"08":1,"100":1,"11":2,"12":2,"123":1,"14":2,"15":1,"150":1,"16":1,"1772":1,"2":2,"2000":1,"2157":1,"2345":1,"3":5,"3419":1,"35":1,"4":2,"41":1,"425":1,"5":2,"566":1,"57":1,"69":1,"7/5/":1,"73261":1,"9/20/1997":1,"9884":1,"Allstate":1,"B":1,"Company":1,"D":1,"Davidson":1,"E":1,"Ford":1,"GEICO":1,"Gmail":1,"H":1,"I":1,"I'd":1,"I'll":1,"I'm":1,"I've":1,"Laura":1,"Lisa":1,"Main":1,"Mister":1,"N":1,"Nevada":1,"R":1,"Street":1,"TV":1,"Way":1,"Z":1,"absolutely":1,"access":7,"account":21,"accounts":1,"actual":1,"adage":1,"add":2,"additional":2,"address":13,"adjusted":1,"allergy":1,"alright":52,"answer":3,"apologize":1,"appointment":3,"approved":2,"assist":3,"assistance":1,"assure":1,"automatic":1,"avoid":1,"awesome":2,"bad":1,"bank":1,"basically":1,"billing":5,"bills":2,"birth":1,"bit":1,"boy":1,"business":3,"bye-bye":5,"calculated":1,"calling":16,"caps":1,"car":3,"card":1,"cat":1,"chance":1,"change":2,"characters":1,"cheaper":3,"check":3,"choosing":1,"chronically":1,"claim":12,"claims":2,"clean":2,"closely":1,"code":6,"commission":1,"company":1,"complete":3,"computers":1,"confident":1,"confirm":3,"confirming":1,"cool":1,"corporation":2,"correct":9,"cost":2,"council":1,"cover":1,"coverage":1,"credentials":1,"curious":1,"customer":3,"dad":1,"damage":4,"damages":1,"data":1,"day":2,"days":2,"debit":1,"depend":1,"difficult":1,"digging":1,"direct":1,"disasters":1,"discount":8,"doctors":1,"dollars":6,"driver":5,"drivers":2,"e-mail":23,"eat":1,"electronically":2,"enroll":1,"enter":1,"estimate":1,"evening":1,"expenses":1,"experience":1,"extreme":1,"farmers":1,"fault":1,"feeling":1,"fell":1,"female":2,"field":1,"file":3,"fine":3,"forgotten":1,"fresh":1,"garden":1,"goodbye":2,"goodness":1,"grade":2,"grades":2,"guess":3,"guys":2,"happen":1,"happened":2,"happy":4,"heart":1,"helpful":4,"helping":1,"hey":6,"history":1,"hold":2,"hope":4,"house":4,"housing":1,"hurricanes":1,"idea":2,"ideology":1,"improve":2,"inconvenience":1,"increase":1,"indication":1,"info":1,"insurance":16,"insures":1,"invite":1,"issue":4,"issues":2,"kinda":1,"kitty":1,"letter":3,"letters":1,"link":3,"listen":2,"locked":1,"log":14,"lot":1,"love":2,"ma'am":5,"mail":2,"major":1,"manager":8,"matter":1,"mention":1,"message":3,"mind":3,"missed":2,"mom":1,"moment":2,"moments":1,"month":7,"nationwide":1,"navigate":2,"negligence":1,"night":1,"note":5,"offer":1,"offering":1,"offers":1,"office":2,"online":6,"opposed":1,"option":2,"outline":1,"overview":1,"paid":1,"paper":2,"paperless":4,"papers":1,"password":10,"path":1,"pause":3,"paws":2,"paying":1,"payment":7,"payments":1,"peers":1,"percent":2,"perfect":2,"person":1,"phone":14,"plan":2,"plans":3,"play":1,"policy":14,"popular":1,"portal":2,"post":1,"potential":2,"powerful":1,"prefer":1,"premium":1,"pretty":1,"price":2,"process":2,"progressive":2,"provide":1,"question":2,"questions":2,"quick":3,"quote":4,"rate":2,"reach":2,"reading":1,"real":2,"reason":3,"receive":6,"received":6,"receiving":1,"recording":1,"reflected":1,"relate":1,"remarks":1,"remember":1,"reset":3,"respective":1,"rest":2,"rough":1,"satisfaction":5,"savings":1,"schedule":1,"screen":1,"script":1,"send":7,"service":3,"setting":1,"shoes":1,"short":2,"shortly":2,"shot":1,"sign":2,"singing":1,"sitting":1,"sort":1,"sounds":3,"speak":2,"standing":1,"start":1,"started":3,"statement":1,"stay":3,"staying":2,"survey":5,"switch":1,"switched":1,"switching":2,"table":1,"takes":2,"talk":3,"teachers":1,"team":2,"tech":1,"temporary":3,"tenants":2,"term":2,"time":10,"times":3,"tornadoes":1,"totally":1,"traditional":1,"type":1,"um-hum":1,"understand":6,"understood":1,"update":2,"updated":1,"valid":1,"verification":4,"verified":3,"verify":4,"wanna":5,"weather":1,"wonderful":1,"wondering":1,"wood":1,"word":1,"yahoo":3,"yep":3,"zebra":1}
Response and Error Codes

Code

Response

200

OK – The request has succeeded.

401

{“reason”:”Authentication failed”}

422

{“error”: “Error while decoding response from the database”}

500

{“error”: “Internal server error”}

In this section: