Click to Dial via API

Using this API, you can trigger an outbound call for a given agent who is logged into the Contact Center Agent Client.

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

Will Click to Dial the number for the agent.

Arguments

AgentExt

The agent's extension number

numberToDial

The number the agent should dial. This can be an extension or an external number. It should be formatted as the agent would dial it.

outboundCallerID

OPTIONAL: Which caller ID number should the agent's call go out as?
Note: The outbound caller ID needs to be a number that is available to agents as a registered number in Xima CCaaS. Learn more

externalPrefix

OPTIONAL: The dial out external prefix, e.g., 9.
{
  "numberToDial" : "8017132800",
  "outboundCallerId" : "3855551234", //Optional
  "externalPrefix" : "9", //Optional
}


Response

204 status code for success.

Status CodeFailure

400 Bad Request

Malformed JSON request body.

401 Unauthorized

The authorization header wasn’t valid.

403 Forbidden

The authenticated user doesn’t have Xima CCaaS access to view data for one or more of the requested agents or groups.