API Reference
  1. KrickTalk Partner API
  2. Calls

Place a click-to-call

post
https://partner-api.kricktalk.com/v1/domains//calls

Rings one of the domain's users, then dials destination and bridges the two.
A success response means the origination was accepted, not that the call connected. The outcome arrives on the call_log.created webhook when the call completes; match it using the call_id returned here.
Requires appropriate permission and an active integration on the requested domain.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The domain name of the integration-bearing customer you are acting on behalf of — for example yourcustomer.kricktalk. This is not the numeric domain returned by /v1/auth, which identifies your own service user's domain.

Body Params
string
required

The user who places the call — their phone rings first, and must be answered in order to bridge the call. Must be a user_id from GET /v1/domains/{domain_id}/users on this domain.

string
required

Who to call: a US number in E.164 form (+1XXXXXXXXXX) or a 3–5 digit extension on the same domain.

string

Optional label shown to from_extension while their phone rings, so the user knows who they are about to be connected to. Defaults to destination. Matches [a-zA-Z0-9.#$_\-!]{3,100}.

string

Optional number shown to the person being called. Defaults to the domain's configured outbound number for an external destination, or to from_extension for an internal one. When supplied for an external destination it must be a valid US number in E.164 form and must belong to the domain; for an internal destination it must equal from_extension.

Responses

Updated 11 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago

Did this page help you?