Click2Call
#

Click2Call
#

Click2Call
#

Use the click2call (click-to-call) API to enable agents to initiate calls from third-party applications, such as CRMs, without manually dialing a number.

Use Case
#

The Click2call API enables contact center agents who use a CRM to call contacts to click a phone number or icon on a CRM contact record to automatically dial a number in the Voiso Agent Panel. The Click2call API gets the agent extension and the destination number and automatically dials the number. The agent handles the interaction in Agent Panel. The call data is saved in your Voiso contact center database. The call data is saved in your Voiso contact center database.

Request example
#

When an agent initiates a call from a CRM, the backend client should send Voiso an HTTP POST startcall or HTTP POST stopcall request to the following URL:

https://{cluster_id}.voiso.com/api/v1/{client_api_key}/click2call

where:

  • cluster_id is the Voiso cluster where your contact center is located. You can obtain the cluster ID from your account manager. It is the first part of your account URL.Sample URL showing contact center name
  • client_api_key is the Contact Center API key

The following is an example of a request in a browser:

https://cc.voiso.com/api/v1/a204cf426a66db3f2680f211b29978a10ed78fff247ad35f/click2call?agent=1234&number=11461571011&get_call_id=true

Simplified request
#

The CRM or other client should send Voiso a JSON object with these two mandatory fields:

{ 
 "agent": "222",
 "number": "11461571011"
}

where 222 is the agent's extension and 11461571011 is the destination number.

Extended request with optional parameters
#

The extended request may include account_id, crm, and get_call_id.

{
  "agent": "333",
  "number": "12121324040",
  "account_id": "AC123456",
  "crm": "Any_CRM",
  "get_call_id": true
}

where:

  • 333 is the agent's extension
  • 12121324040 is the destination number
  • AC123456 is the ID of the contact in the CRM database. Some CRMs use an Account ID to represent the organization the contact belongs to; however, this parameter refers specifically to the contact's ID.
  • Any_CRM is the name of your CRM
  • Use boolean get_call_id to get a UUID of the call in the body of a response message

Troubleshooting
#

The following issues are sometimes encountered:

User not found
#

{"errors":"User not found"}

The specified user (agent) extension does not exist in any of the connected contact centers.