Making a Previewed Outbound Call

Prerequisites

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

Description

After receiving a previewed outbound call event, the agent calls a subscriber using the previewed outbound call interface.

Interface Method

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

URI

https://IP address:Port number/agentgateway/resource/voicecall/{agentid}/previewCallout

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

previewCallout

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	called	String	Yes	Called number. The parameter must be contained in the dialeddigits field of a preview event. If the parameter is not contained in the dialeddigits field, a call cannot be made.
  2	callcontrolid	Long	Yes	Control block ID of a previewed outbound call. The value is the same as that of controllid in the previewed outbound call event.

Response Description

Triggered Event

• AgentOther_PhoneAlerting
• AgentOther_PhoneOffhook
• AgentEvent_Talking
• AgentEvent_Call_Out_Fail

Error Code

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

Example

• Message header

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

• Request parameter

  {
      "called": "88889039",
      "callcontrolid": "11776"
  }

• Response parameter

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