Enables agents to initiate a call from a third-party application, such as a CRM, via the API. Agents are identified by their extensions in the agent parameter. The number parameter specifies the destination numbers.
The extension of the Agent making the call.
The outbound number to dial in E.164 format.
An ID for the contact. Used to mask the phone number in the softphone.
The name of a CRM or other service used to add a tag to the call.
Set to true to get the call_id (the UUID assigned to the call in the CDR) as a json in the response.
All parameters are valid and the API call is successful.
Calls 1
Call records array requested with page based pagination.
{
"call_id": "24f6a191-f0ad-4257-x934-32xx26x51208"
}All parameters are valid and the API call is successful. No content in response.
Incorrect body parameters
Error1
Agent click2call disabled
{
"error": "Click2call is disabled in the agent's security access group."
}Error2
Invalid destination number. Number must be in E.164 format.
{
"error": "Invalid destination number"
}Error3
The agent's extension is not in the correct format or the extension is not assigned.
{
"error": "Invalid agent's extension"
}Error4
The agent is not logged into their softphone.
{
"error": "Agent logged off"
}Invalid api_key
Error1
Invalid API key
{
"error": "Invalid API key"
}