Calling Back Pushed Events
Prerequisites
The agent has signed in.
Description
When the event push mode is used after an agent signs in, the third-party system needs to develop an interface to receive pushed event messages.
Interface Method
The request method must be set to POST. This interface supports only the POST method.
URI
The following is a reference URL:
https://ip:port/service-cloud/rest/cc-ai/v1/agentevent/pushresult
In the URL, ip indicates the IP address of the third-party server, and port indicates the HTTPS port number of the third-party server.
Method Name in Logs
None
Request Description
- Message header
Table 1 Parameters in the request message header No.
Parameter
Value Type
Mandatory (Yes/No)
Description
1
Content-Type
string
Yes
Coding mode of the message body. The default value is application/json; charset=UTF-8.
2
Guid
string
Yes
GUID returned by the sign-in interface during static authentication (AUTHMODE is set to 1) or GUID returned by the polling event query interface during dynamic authentication (AUTHMODE is set to 2).
3
service_token
string
No
User-defined. The value contains a maximum of 50 characters and cannot contain special characters. Otherwise, 100-001 is returned. It is recommended that the page be dynamically refreshed every minute.
- Message body
Table 2 Parameters in the message body No.
Parameter
Value Type
Mandatory (Yes/No)
Description
1
workNo
string
Yes
Agent ID.
2
eventList
array
Yes
Event list.
For details about the parameters of this object, see Table 3.
NOTE:Events are listed from left to right by generation time. The latest events are displayed on the right.
Response Description
No. |
Parameter |
Value Type |
Description |
---|---|---|---|
1 |
message |
string |
Description. |
2 |
retcode |
string |
Error code. The options are as follows:
|
Example
- Message header
Content-Type:application/json; charset=UTF-8 Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 service_token:******************
- Request parameter
{ "workNo": "", "eventList": [ { "eventType": "", "workNo": "", "content": "" }, { "eventType": "", "workNo": "", "content": "" } ] }
- Response parameter
{ "message": "success", "retcode": "0" }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot