Programmatically make a call (Click to Dial) for an agent who is logged into CCAC.

• If the agent is using the Xima softphone (WebRTC), the call will instantly go out for the agent.
• If using a UC phone, the agent will first be engaged by a Xima registered extension. once the agent answers the ringing phone, the outbound call will be initiated.

Click to Dial

POST /rest/api/v1/agents/{AgentExt}/click-to-dial

Headers

Prior to configuring an API request, you'll need a service user and accompanying bearer token to authorize the request.

Learn how to build a user and obtain a key here.

Body

{
  "numberToDial" : "8015552800",
  "outboundCallerId" : "3855551234", //Optional
  "externalPrefix" : "9", //Optional
}

Arguments

If you'd prefer not to set the outbound ID, you may this method instead

Response

204 status code for success.

Click to Dial with Last Selected Outbound Number

Some agents may have more than one available outbound number. If your click to dial POST can make the number static, you should use the API POST request as outlined in the above section and define the "outboundCallerId" value to be the applicable number.
If you need to the click to dial to utilize whatever the agent has selected as their outbound caller ID with their most recent call, you can use this POST instead:

POST /rest/api/v1/agents/{AgentExt}/click-to-dial

Headers

Prior to configuring an API request, you'll need a service user and accompanying bearer token to authorize the request.

Learn how to build a user and obtain a key here.

Body

{
  "numberToDial" : "8015552800",
  "useSelectedOutboundCallerId" : "true"
}

Arguments

Programmatically Updating the useSelectedOutboundCallerId for an agent

If you like to update the useSelectedOutboundCallerId, you may send a new POST. After sending this POST successfully the agent will see the updated label and number as their currently selected outbound number if they were to manually dial out from CCAC. If this command is immediately followed by a click to dial POST, the updated number would be the one used for the outbound call ID.z

POST /rest/api/v1/agents/{AgentExt}/selected-outbound-caller-id

Headers

Prior to configuring an API request, you'll need a service user and accompanying bearer token to authorize the request.

Learn how to build a user and obtain a key here.

Body

{
  "label" : "Support",
  "outboundCallerId" : "3855550113 "
}

Arguments

Obtaining the List of Available Outbound Numbers and Labels for an Agent

To obtain a list of outbound numbers and their labels that are available for a given agent, you may send this authenticated POST. It will also return the agent's currently selected outbound ID .

GET /rest/api/v1/agents/{AgentExt}/outbound-caller-ids

Headers

Prior to configuring an API request, you'll need a service user and accompanying bearer token to authorize the request.

Learn how to build a user and obtain a key here.

Body

No body needed in the GET request

Returned JSON

{
    "selectedOutboundCallerId": {
        "label": "Support",
        "outboundCallerId": "3855550113"
    },
    "outboundCallerIds": [
        {
            "label": "Support",
            "outboundCallerId": "3855550113"
        },
        {
            "label": "Warranty Team",
            "outboundCallerId": "8015553827"
        }
    ]
}

Arguments