https://api-ai.zixflow.com.
Sending is POST /api/ingest/truecaller/.... Template variables and delivery results are GET /api/data/....
A send returns 200 when the message is queued. Delivery, media-type checks, and bot checks happen after that and show up on the delivery report.
The bot id is the Truecaller channel id from Settings → Channels → Truecaller.
Endpoints
Authentication
Every endpoint requires both headers. The workspace on the key must matchx-workspace-id. See Authentication.
Auth failures use a different body from validation failures:
401.
Errors
Validation and handler errors (ingestion and data APIs):; .
Auth, wallet, and rate-limit middleware:
A balance of exactly 0 is allowed at ingestion. The wallet is charged later, when the message is processed. A later wallet failure is a failed delivery report. The send has already returned HTTP
200.What 200 means
Ingestion success has no data wrapper:
request_id means the message was accepted onto the queue. Poll Get Message Delivery Report with that id. A 404 can mean processing has not written the log yet.
If processing rejects the message, the log status is failed and remark carries the reason. When a status code exists it is appended as (Code: …).
Billing
Billing runs at processing time. If the recipient replied in the last 24 hours, the message is a conversation. Otherwise plain text with no buttons is outbound basic, and any media or buttons are outbound advanced. The international price is used when the recipient’s country differs from the bot’s country. A message that ends failed, including no delivery before the TTL, is refunded.Shared send fields
Present on every ingestion body.Buttons
buttons is optional on text, image, video, and document sends. Maximum 3. A template send has no buttons field. Buttons are part of the saved template.
Checked immediately: count, text length, type, and the field that type requires (url, phone_number, or list.options).
Checked after queueing: action_tag shape, duplicate tags, link URL shape, phone shape, and unique list option ids and titles.
Reply. A tap comes back as an inbound message with the button text and
action_tag. No default tag is added.
Link. If action_tag is omitted, it becomes link_1, link_2, … Clicks are reported by that tag.
List (list object):
Text
Every message has text, including image, video, and document. Truecaller rich text in that string:
Template placeholders:
brand. are filled by Zixflow. The variable-keys API leaves those keys out.
Media
One file per message. The URL is sent to Truecaller as given. It must be a publichttp:// or https:// URL. Truecaller’s file size limit is 20 MB. The file is not downloaded to measure it before queueing.
mime_type is optional when the URL path ends in a known extension. The extension is taken from the path, not the query string.
A missing type, or a type that does not match the send (for example
video/mp4 on an image), fails after queueing with 91405.
file_name is documents only, optional, shown to the recipient, at most 255 characters. Checked immediately.
Reports
Delivery, summary, and logs use the shared message APIs. For Truecaller,channel is truecaller. Summary and logs are cached and rate limited. See Get Message Delivery Report, Get Message Reports Summary, and Get Message Report Logs.