Fetch Alerts
Fetch Alerts API retrieves the alerts generated for a given contact.
Endpoint
Method: GET
URL: alerts/{contactId}
Header Parameter
Authorization Bearer <Token>
Path Parameter
Parameter Name | Mandatory/ Optional | Type | Description |
|---|---|---|---|
| Mandatory | string | Id of the contact whose alerts needs to be fetched |
Example Request
curl -H “Authorization: Bearer 911999706310ffbcb32981863e23ce72d5e60d7b” -XGET http://host:port/alerts/{contactId}
Example Response
{
"id": "an identifier assigned by the persistence layer",
"sessionId": "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",
"contactType": "voice",
"journeyId": "c4nq0x0o",
"tenantId": "1",
"organizationId": "2",
"categoryId": "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”} |