Subscription

Description

This interface is used by a third-party business client to send a subscription task registration request to the CTI platform of the call center so that third-party business client can receive event notifications from the CTI platform of the call center.

NOTE:

• The CC-Gateway address needs to be configured on the Manage Subscription Server page of the web configuration console.
• After this interface is successfully invoked, that is, the value of retcode is 0, the handshake interface can be invoked to remain the subscription status.

Interface Method

This interface supports only the POST method.

URI

https://IP:Port/agentgateway/resource/config/subscribe/register

Method Name in Logs

register

Request Message

• Message header

  Table 1 Parameters in the message header

  No.	Parameter	Value Type	Mandatory	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	The value of Guid is that returned through the interface in C5 Intelligent Auxiliary Interface Authentication.

• Message body

  Table 2 Parameters in the message body

  No.	Parameter	Value Type	Mandatory	Description
  1	subscribeType	String	Yes	Subscription type. 1: recognition Others: reserved
  2	serviceToken	String	No	Authentication token, which is generated by a third-party service. Example: 3320EA********************36ED638 The value contains a maximum of 256 characters. This parameter needs to be transferred when the interfaces described in Handshake (Extended) and Recognition Result Notification are invoked.
  3	serviceCallBackUri	String	Yes	Event notification callback address. The value contains a maximum of 200 characters.
  4	nlpFlag	Boolean	Yes	Whether to use intelligent semantic analysis. true: Use intelligent semantic analysis. You need to contact O&M personnel to configure the CC-Gateway callback URL in the basic.properties file of the CC-Gateway. false: Do not use intelligent semantic analysis.
  5	flowAccessCode	String	No	Intelligent IVR chatbot access code, which is returned when a chatbot is added. This parameter needs to be set only when nlpFlag is set to true.

Response Message

Example

• Message header

  Content-Type:application/json; charset=UTF-8
  Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
• Request parameter

  {
      "subscribeType": "1",
      "serviceToken": "3320EA1E***********8E336ED638",
      "serviceCallBackUri": "https://10.10.10.1:8080/rest/cc-ai/nlrresult",
      "nlpFlag": "true",
      "flowAccessCode": "801166010768953344"
  }
• Response parameter

  {
      "result": {
          "serverId": "20140414172508-001-00101"
      },
      "message": "success",
      "retcode": "0"
  }