HomeGuidesAPIsChangelogCreate a Ticket
APIs
  1. Action APIs

Click-to-Dial

post
https://{hostname}.xima.cloud/rest/api/v1/agents//click-to-dial

Triggers an outbound call for a specified agent who is currently logged into the Contact Center Agent Client.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

When the agent is using the Xima softphone (WebRTC), the call is placed immediately. When the agent is on a UC phone, the system first rings the agent's extension — once answered, the outbound call is then initiated to the target number.

Path Params
string
required

The agent's extension number

Body Params
string
required

The number or extension the agent should dial, formatted as the agent would dial it.

string

The outbound caller ID the call should present. Must be a number registered in CCaaS. Omit to use the agent's currently selected outbound caller ID instead.

string

The external dial prefix (e.g., "9").

boolean

When set to true, uses the agent's currently selected outbound caller ID. Default is false.

Response
204

No Content — call successfully triggered.

Updated 4 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 4 months ago