Keywords (Query)
Keywords API enables customers and partners to get the keyword dump based on call id and BR id.
Endpoint
Method: GET
URL: keywords?contactId=<id>&brId=<id>
Header Parameter
Authorization Bearer <Token>
Query Parameters
Parameter Name | Mandatory/ Optional | Type | Description |
|---|---|---|---|
| Mandatory | string | Contact Id as query filter |
| Optional | string | BR Id as query filter |
Example Request
curl -H "Authorization: Bearer 911999706310ffbcb32981863e23ce72d5e60d7b" -XGET http://host:port/analytics/keywords?contactId=60525&brId=1179
Example Response Payload
[
{
"contact-id": "60119",
"cat-id": "75",
"br-id": "1179",
"text": "Michelle",
"start": 4488,
"end": 4608,
"channel": "Customer"
},
{
"contact-id": "60119",
"cat-id": "75",
"br-id": "1179",
"text": "Michelle",
"start": 2536,
"end": 3036,
"channel": "Customer"
},
{
"contact-id": "60119",
"cat-id": "75",
"br-id": "1179",
"text": "thank you",
"start": 90780,
"end": 91140,
"channel": "Agent"
}
]
Response and Error Codes
Code | Response |
|---|---|
200 | A List of keywords fetched after filtered by contactId, brId |
400 | {“reason”: “contactId is missing”} |
401 | {“reason”: “Authentication Failed”} |
500 | {“reason”: “Internal Server Error”} |