Query notification records that were not sent using Message Queue (MQ).
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The ID of the Cloud Contact Center instance. |
ccc-test |
| NotificationKeys |
string |
Yes |
A list of notification keys to query. For example, if you specify a call ID, the API returns all notifications for that call ID. |
["job-468a63a2-****-****-****-b1ecf726d4be","job-532a63a2-****-****-****-bcccc26d4cc"] |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Code |
string |
The response code. |
OK |
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| Message |
string |
The response message. |
无 |
| RequestId |
string |
The request ID. |
0630E5DF-CEB0-445B-8626-D5C7481181C3 |
| Data |
array<object> |
Data. |
|
|
object |
A list of notifications. |
||
| NotificationType |
string |
The message type. |
Dialing |
| NotificationKey |
string |
The notification key. |
job-468a63a2-****-****-****-b1ecf726d4be |
| Content |
string |
The notification content. |
{ "agentId": "agent@ccc-test", "callType": "OUTBOUND", "callee": "13****00", "caller": "05****81", "channelId": "ch-user-13****00-05****81-1772619731285-job-*****", "contactId": "job-*****", "eventTime": "2026-03-04T10:22:11.309Z", "eventType": "Dialing", "instanceId": "ccc-test", "mediaType": "AUDIO", "skillGroupId": "skill@ccc-test" } |
| InstanceId |
string |
The instance ID. |
ccc-test |
| Params |
array |
A list of invalid parameters. |
|
|
string |
An invalid parameter. |
无 |
Examples
Success response
JSON format
{
"Code": "OK",
"HttpStatusCode": 200,
"Message": "无",
"RequestId": "0630E5DF-CEB0-445B-8626-D5C7481181C3",
"Data": [
{
"NotificationType": "Dialing",
"NotificationKey": "job-468a63a2-****-****-****-b1ecf726d4be",
"Content": "{\n\t\"agentId\": \"agent@ccc-test\",\n\t\"callType\": \"OUTBOUND\",\n\t\"callee\": \"13****00\",\n\t\"caller\": \"05****81\",\n\t\"channelId\": \"ch-user-13****00-05****81-1772619731285-job-*****\",\n\t\"contactId\": \"job-*****\",\n\t\"eventTime\": \"2026-03-04T10:22:11.309Z\",\n\t\"eventType\": \"Dialing\",\n\t\"instanceId\": \"ccc-test\",\n\t\"mediaType\": \"AUDIO\",\n\t\"skillGroupId\": \"skill@ccc-test\"\n}",
"InstanceId": "ccc-test"
}
],
"Params": [
"无"
]
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | Parameter.Maximum | The parameter %s must be less than or equal to %s. | |
| 400 | Parameter.Minimum | The parameter %s must be greater than or equal to %s. | |
| 400 | Parameter.Null | The parameter %s may not be null. | |
| 404 | NotExists.InstanceId | The specified instance %s does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.