Configuring Call-Associated Data (Extended)

Prerequisites

• The agent has signed in.
• The agent is in a call.

Description

This interface is used by an agent that is in a conversation after signing in to configure call-associated data.

Interface Method

The request method must be set to PUT. This interface supports only the PUT method.

URI

https://ip:port/agentgateway/resource/calldata/{agentid}/setcalldataex

In the URL, ip indicates the IP address of the CC-Gateway server, and port indicates the HTTPS port number of the CC-Gateway server.

Method Name in Logs

setCallAppDataEx

Request Description

• Message header

  Table 2 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).

• Message body

  Table 3 Parameters in the message body

  No.	Parameter	Value Type	Mandatory (Yes/No)	Description
  1	callid	string	No	Indicates the ID of a call.
  2	calldata	string	No	Indicates call-associated data. The maximum value of the original content is 16 KB. NOTE: The information is encrypted using AES128-CBC and transmitted through the TLS1.2 encryption channel. This field contains sensitive data. In logs, only calldatalength is used to indicate the length of this field.
  3	isDataEncoded	boolean	No	Whether call data is encoded using Base64. The options are as follows: true: Call data must be encoded using Base64. false: Call data is not encoded using Base64. The default value is false. NOTE: Base64 is an encoding mode, but not an encryption algorithm. It cannot be used to encrypt any sensitive information.

Response Description

Triggered Event

• None

Error Code

• 000-002
• 100-006
• 100-007
• 400-001

Example

• Message header

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

• Request parameter

  {
      "callid": "1456229294-1191",
      "calldata": "1233",
      "isDataEncoded": "true"
  }

• Response parameter

  {
    "result": {},
    "message": "success",
    "retcode": "0"
  }