Fetch Alerts for a Conversation
Alerts API retrieves the alerts generated for a given conversation ID.
Endpoint
Method: GET
URL: https://api.<region>.cloud.uniphore.com/v2/alerts/{conversationId}?tenantid=<tenant_id>&environment=<env_name>
Request
curl -H “Authorization: Bearer 911999706310ffbcb32981863e23ce72d5e60d7b” -XGET https://api.<region>.cloud.uniphore.com/v2/alerts/{conversationId}?tenantid=537&environment=dev
Header Parameter
Authorization - Bearer <Token>
Path Parameter
Parameter Name | Mandatory/ Optional | Type | Description |
|---|---|---|---|
| Mandatory | string | Id of the conversation whose alerts needs to be fetched |
Query Parameters
Parameter Name | Mandatory / Optional | Data Type | Description |
|---|---|---|---|
| Mandatory | String | The unique identifier for your account. |
| Optional | String | Operating environment type. Three out-of-the-box environments are provided for each account:
|
Example Response
{
"id": "an identifier assigned by the persistence layer",
"conversationId": "the contact session id",
"startTime": 1602011595000,
"sequenceNumber": 1,
"resolved": false,
"alert": {
"name": "a name",
"message": "a message",
"type": "type of alert",
"recipient": "recipient of this alert",
"displayCount": 1
},
"metadata": {
"agentId": "an agent identifier",
"customerId": "a customer identifier",
"agentClientId": "an agent id from the client",
"customerClientId": "a customer id from the client",
"conversationType": "voice",
"journeyId": "c4nq0x0o",
"tenantId": "1",
"organizationId": "2",
"businessProcessId": "76"
}
}
Response and Error Codes
Code | Response |
|---|---|
200 | OK – The request was successful |
401 | {“reason”:”Authentication failed”} |
404 | Record Not Found |
500 | {“error”: “Internal server error”} |