Skip to main content
POST
Send Truecaller Template

Description

Sends a saved template by name. The template must belong to bot_id. Variables replace placeholders in the template text, media URL, and links. A template send has no buttons field. Buttons are part of the saved template. variables must be present. {} is valid when the template has no caller variables. Keys are the names from Template variable keys, without braces. Placeholders that start with brand. are filled by Zixflow and are left out of that list. A 200 means the message was queued. See Introduction for auth errors, wallet checks, processing codes, and billing.

Headers

string
required
Your API key for authentication. The workspace on the key must match x-workspace-id.
string
required
Workspace id that owns the API key.
string
required
application/json

Body

string
required
Phone number. An empty value is rejected immediately. After the message is queued, the number is normalized with the workspace country, so a local number is accepted. A number that cannot be normalized fails with code 90103 (INVALID_RECIPIENT_NUMBER).
string
required
Truecaller bot id from Settings → Channels → Truecaller. 24-character hex. An unknown bot fails after queueing with 91401 (INVALID_TRUECALLER_BOT_ID). A paused bot fails with 91402 (TRUECALLER_BOT_PAUSED).
integer
How long Truecaller keeps trying to deliver the message. Integer from 1 to 2419200 (28 days). Omit it to use the bot’s default TTL. When that default is 0, processing uses 86400 (24 hours). No delivery report by then marks the message failed. A value outside the range fails after queueing with 91406 (INVALID_TRUECALLER_TTL).
string
Stored on the delivery log with the send. There is no format check. The HTTP body posted to this URL is not defined by this API.
string
Stored on the delivery log with the send.
string
required
Name of the template on that bot. An unknown name, or a template that belongs to another bot, fails after queueing with 91403 (INVALID_TRUECALLER_TEMPLATE_NAME).
object
required
Object of string to string. Must be present. {} is valid when the template has no caller variables. Keys are the names from the variable-keys API, without braces.

Request Example

Response

boolean
true when the message was accepted onto the queue.
string
Truecaller request queued successfully on success. On validation failure, field errors joined with ; .
string
Present when success is true. UUID. Use it on the delivery-report API. It is also the campaign id of the log.