Get SDK
API Docs by APIMATIC

Startcall
#

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 in the agent parameter. The destination numbers are specified in the number parameter.

POST /api/v1/{api_key}/click2call

API Code Playground

Endpoint Arguments
Parameters
Required
Required
String
Query

Agent's extension

Required
String
Template

Contact center API key

Required
String
Query

Outbound number to dial

String
Query

External identifier

String
Query

CRM tagging

Boolean
Query

Set to true to get the call_id 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://www.example.com/api/v1/ZXTf40WQMcQQJHZKGMhHL8av1AvonVHy/click2call'  \
  -d 'agent=347' \
  -d 'number=16461572020' \
  -d 'account_id=12345678' \
  -d 'crm=my_crm'