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 address:Port number/service-cloud/rest/cc-ai/v1/agentevent/pushresult

HTTPS of the TLS 1.2 or a later version is used to ensure that sensitive web application data is not illegally intercepted during transmission

If the CC-Gateway is deployed in single-node mode, set IP address to the CC-Gateway server address and Port number to the HTTPS port number of the CC-Gateway server (the default value is 8043). If the CC-Gateway is deployed in cluster mode, set IP address to the NSLB address and Port number to the default value 8043.

For the CC-Gateway port number on the NSLB, log in to any NSLB node as the nslb user and run the ./nslbctl l command to query the port number. In the query result, the following port is opened by the CC-Gateway to third-party systems through the NSLB.

In the SaaS scenario, contact O&M personnel to obtain the values of IP address and Port number.

Method Name in Logs

pushEvent

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.

  Table 3 Parameter description of eventList

  No.	Parameter	Value Type	Description
  2.1	eventType	String	Event type.
  2.2	workNo	String	Agent ID.
  2.3	content	Object	Event content.

Response Description

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"
  }