Skip to main content

Uniphore Customer Portal

Fetch Metadata from Transcripts

This API helps to fetch metadata information of contacts processed within the given date range for the specific category and organization.

  • External System can provide the 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 the response.

Endpoint

Method: GET

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

Header Parameter

Authorization - Bearer <Token>

Query Parameters

Parameter name

Mandatory/Optional

Type

Description

organizationId

Mandatory

string

Organization ID from which metadata information to be fetched

startTime

Mandatory

long

Beginning date range for the query

endTime

Mandatory

long

Ending date range for the query

categoryIds

Optional

string

Category ID from which metadata information to be fetched

agentIds

Optional

string

List of agent IDs to query

contactTypes

Optional

string

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

clientContactIds

Optional

string

List of client contact IDs to query

customerId

Optional

string

Customer ID to query

externalMetadata

Optional

string

A map of external metadata to query (example: 1234=agent1,agent2;1235=5105790001)

Example Request
curl --location --request GET 'http://host:port/query?categoryIds=<ids>&organizationId=<id>&startTime=<epoch-time>&endTime=<epoch-time>' \
--header 'Authorization: Bearer 1234567890'
Example Response
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: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: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:25
data:{"_id":"6172a2a463ada8c0a831a75f","sessionId":"25","lang":"en-us","searchLang":"en","startTime":1612001410000,"metadata":{"agentId":"3","organizationId":"9","tenantId":"1","customerId":"3","contactId":"3dabe71e-7ded-49f5-ba8b-567960bd83b9","categoryId":"11","type":"batch","contactType":"voice","convId":"smokestereo31jan5","journeyId":"journeysmokestereo31jan5","isDiarized":true,"contactDuration":174322,"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: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: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: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: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: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}

data:{"_id":"000000000000000000000000","sessionId":"","searchLang":"","startTime":0,"metadata":{"organizationId":"","categoryId":"","type":""},"isChunk":null,"isLastChunk":null,"__ts":0}
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: