• REST
  • Java
Get SDK

Startcall

API Docs by APIMATIC

Startcall
#

  • REST
  • Java

Startcall
#

Enables agents to initiate a call from a third-party application, such as a CRM, via the API. Agents are identified by their extensions or login ID (sign-in email address) in the agent parameter. The number parameter specifies the destination numbers.

POST /api/v1/{api_key}/click2call

API Code Playground

Endpoint Arguments
Parameters
Required
Required
String
Query

The extension or login ID (sign-in email address) of the Agent making the call.

Required
String
Template

The Contact Center API key.

Required
String
Query

The outbound number to dial in E.164 format.

String
Query

An ID for the contact. Used to mask the phone number in the softphone.

String
Query

The name of a CRM or other service used to add a tag to the call.

Boolean
Query

Set to true to get the call_id (the UUID assigned to the call in the CDR) as a json in the response.

get_call_id

Responses

  • 200
  • 204
  • 400
  • 403

All parameters are valid and the API call is successful.

application/json

Type

Object

{
  "call_id": "24f6a191-f0ad-4257-x934-32xx26x51208"
}
  • Request
  • Response
curl -X POST -G \
  --url 'https://{cluster_id}.voiso.com/api/v1/%7Bcontact_center_api_key%7D/click2call'  \
  -d 'agent=347' \
  -d 'number=16461572020' \
  -d 'account_id=12345678' \
  -d 'crm=my_crm'