All pages

API reference

The transactional API — the messages your systems send, not the ones your marketing does.

This API exists for the messages a system sends: an order confirmation, a delivery update, a one-time password. One customer, one event, right now.

It is not the campaigns API, and the difference is not cosmetic.

BroadcastsThis API
Triggered byA person, in the consoleYour code, on an event
AudienceA list computed from consentOne customer
Typical categoryMarketingUtility or authentication
Reaches an opted-out contactNoYes, for utility and authentication

If you find yourself looping this endpoint over a list of customers, you want broadcasts instead.

Base URL

https://app.katexs.com/api/v1

Endpoints

MethodPathWhat
POST/messagesSend a template to one customer
POST/codesSend a one-time code
POST/callsRing one customer, and get the results back
GET/calls/{id}A call's results — summary, fields, transcript, recording
DELETE/calls/{id}Cancel a waiting call, or end a live one
POST/calls/batchRing up to 200 people
GET/callsList calls
…/agents, /agents/{id}Agents — create, read, update, delete
…/agents/{id}/knowledgeWhat an agent knows
…/agents/{id}/actionsActions — let the agent call your own API
POST/agents/{id}/test-chatTalk to your own agent and read its reply
GET/templates, /sequencesThe template names and sequence ids the sending endpoints take
…/campaigns, /campaigns/{id}Campaigns — results, and pause, resume, cancel
…/conversations/{id}/status, /assign, /membersResolve, hand back, take over and assign
GET/usage, /agents/{id}/analytics, /calls/summary, /whatsapp/summaryUsage and analytics — the numbers to build a dashboard on
GET/voices, /models, /phone-numbersThe lists an agent is configured from
…/contacts, /contacts/{id}Contacts
…/webhooks, /webhooks/{id}Webhook endpoints
POST/eventsReport an event, which can enrol a contact in a sequence
POST/sequences/{sequenceId}/enrolmentsEnrol a contact directly

Every id is prefixed by what it is — ag_, act_, cmp_, cust_, doc_, wh_ — and every list takes limit (up to 100) and cursor, answering { "items": […], "nextCursor": "…" | null }. Resource endpoints share a limit of 240 requests a minute per workspace.

What it will not do

Warning

  • Send an unapproved template. Meta refuses it, so we refuse it earlier and with a clearer message.
  • Send marketing to somebody who opted out. Refused with 409. Utility and authentication still reach them, and must.
  • Send free-form text. Outside the 24-hour window WhatsApp carries only approved templates. Inside it, the conversation belongs to the agent and the inbox.

Start here

Authentication

Creating a key, and where it must not go.

Send a message

The one endpoint most integrations need.