Agent Session Quantity Configuration: setcallnums

Description

This interface is used by the agent system to change the maximum number of signed-in agents' sessions of a media type.

Interface Method

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

URI

https://ip:port/agentgateway/resource/mediacall/{agentid}/setcallnums

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

setCallNums

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	mediaType	string	Yes	Media type. The options are as follows: 1: text chat 2: click-to-dial call 4: callback request 5: common voice or video call 15: predicted outbound call 16: previewed outbound call 17: message call 51: multimedia web chat 53: social chat NOTE: The media type must be the same as the type of the skill queue to which agents sign in.
  2	callnums	string	Yes	Maximum number of agent sessions. The maximum value is 60, and the minimum value is 1.

Response Description

Triggered Event

• None

Error Code

• 106-003
• 106-008
• 106-012

Example

• Message header

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

• Request parameter

  {
      "mediaType": "53",
      "callnums": "1"
  }

• Response parameter

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