Making a Common Outbound Call

Prerequisites

• The agent has signed in.
• The agent is not answering any call (except a held call).

Description

This interface is used by an agent that has signed in to make an outbound call.

Interface Method

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

URI

https://ip:port/agentgateway/resource/voicecall/{agentid}/callout

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

callout

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	caller	string	No	Calling number. The value can be empty. If the value is empty, the default calling number of the platform is used. The value contains a maximum of 24 digits.
  2	called	string	Yes	Called number. It cannot be left empty and must be a 1- to 24-digit number or * or #.
  3	skillid	int	No	Skill ID. It is in numeral format and can be empty. If the value is empty, the default skill queue ID preconfigured by the platform is used.
  4	callappdata	string	No	Call-associated data. It can be left empty. The maximum value is 16 KB.
  5	mediaability	int	No	Media capability. The default value is 0. The options are as follows: 0: audio; 1: video; 2: A default outbound call is made based on the negotiation between the host and the terminal. NOTE: When a video call is switched to a voice call, the call will be directly disconnected after being answered because media negotiation fails. You are advised to set mediaability to 2 (call with the maximum capability) for video outbound calls.

Response Description

Triggered Event

• AgentOther_PhoneAlerting
• AgentOther_PhoneOffhook
• AgentState_Busy
• AgentEvent_Customer_Alerting
• AgentEvent_Talking
• AgentEvent_Call_Out_Fail
• OUTBOUND_DETECT_EVENT

Error Code

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

Example

• Message header

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

• Request parameter

  {
      "caller": "40038",
      "called": "40040",
      "skillid": 25,
      "callappdata": "",
      "mediaability": 1
  }

• Response parameter

  {
      "message": "",
      "retcode": "0",
      "result": "1455885056-1095"
  }