Skip to main content
Click-to-Call starts a call from your own software. TalkChief first rings the member you name, then connects them to the destination number. Use it to put a call button in a CRM, a helpdesk or an internal tool, with no dialing in the TalkChief app.
The member must be online on a TalkChief device and not already on a call. Otherwise the request fails with error_code 415 or 416.

Before you start

1

Get the Click-to-Call key

As a company admin, go to Integrations → API → Overview & keys. On the Click-to-Call panel, click Generate key if you don’t have one yet. Then click Copy. See Authentication.
2

Decide how to identify the member

You can identify the member who places the call by email address or by extension.
Integrations > API > Click-to-Call reference with the endpoint, the parameter table, an example request and an example response

Place a call

You can send the body as JSON or as form fields. The limit is 300 requests per minute.

Request

string
required
Your 64-character Click-to-Call key. You can send it in the X-API-Key header instead. If both are present, the body value wins.
string
required
The number to dial, with the country code. TalkChief removes every character except digits, , and .. At least 9 characters must remain.
string
Email address of the member who places the call. You must send email or extension. If you send both, TalkChief uses email and ignores extension.
string
Extension of the member who places the call, up to 4 digits. Only used when you don’t send email.
string
default:"true"
Set to true to ring the member’s desk phone and answer it automatically. If that phone can’t take the call, the member’s devices ring normally. Set to false to ring all of the member’s devices. The value must be exactly true or false. A JSON boolean also works.
object
Key/value pairs that come back in the response, such as your CRM record ID. TalkChief adds call_id to this object.
any
Any value. It comes back unchanged in the response.

Example

Response

boolean
true when TalkChief placed the call.
object
string
An empty string when the call succeeds.
200 OK
Store call_id so you can match the call to your CRM record later.

Errors

Click-to-Call returns HTTP 200 for every request it processes. When a request fails, the body has success: false, a numeric error_code, a message and an errors object:
For errors 404 to 414 and 418, message is Validation Error. and the text is in errors. For 415 and 416, the text is in message. For 417, message holds the platform’s reason (or call failed) and errors.error_message_detail holds the detail.

Tips

  • Run the request from your server so the key never reaches a browser.
  • If you get 415, ask the member to sign in to the TalkChief app or desk phone and try again. If you get 416, wait until their current call ends.
  • To track the call after it ends, set up the CDR webhook. It sends a call record when the call finishes.