Skip to main content
This page covers the conventions that all TalkChief integration endpoints share: the base URL, the endpoint list, the response format, errors and rate limits. Request fields for each endpoint are documented on the Click-to-Call and AI Transcription API pages.

Base URL

You can also find this URL in the TalkChief app under Integrations → API → Overview & keys → Base URL. Add the endpoint paths below to it.

Endpoints

The CDR webhook isn’t an endpoint you call. TalkChief sends call records to your endpoint. See CDR webhook.

Request format

  • Use HTTPS.
  • Send JSON bodies with Content-Type: application/json. Click-to-Call also accepts form-encoded fields.
  • Responses are JSON in UTF-8. Transcripts contain unescaped non-Latin text, such as Arabic.

Response format

Every response has the same structure:
When a request fails, success is false. The response adds a numeric error_code, and errors gives details for each field when there are any:

How errors are reported

Click-to-Call answers with HTTP 200 for successful calls and for its own errors. Check success and error_code in the body. Requests over the rate limit get HTTP 429 instead, before the request is processed, so check the HTTP status first. The AI endpoints use real HTTP status codes.

Click-to-Call

Every processed request returns HTTP 200. For failures, error_code is a value from 404 to 418. Requests over the rate limit return HTTP 429 without a body in this format. The full list is in Click-to-Call errors.

AI transcription and AI billing

Rate limits

Limits apply per minute (see the endpoints table). If you go over a limit, you get HTTP 429 Too Many Requests. When that happens, wait and retry with exponential backoff and jitter. If the response includes a Retry-After header, wait at least that many seconds.

OpenAPI specification

To get an OpenAPI 3.0 file covering Click-to-Call, AI Transcription, AI billing and the CDR webhook payload, go to Integrations → API → OpenAPI Spec. Click Download JSON to import it into Postman or Insomnia, or to generate a typed client. Click Download PDF for a printable reference.
Integrations > API > OpenAPI Spec with Download JSON and Download PDF buttons and a preview of the specification

Next steps

Authentication

Generate, send and rotate your API keys.

Click-to-Call

Place calls from your own application.

AI Transcription API

Transcribe recordings, with each speaker’s lines labeled.

CDR webhook

Receive call records at your endpoint.