Docs
ChangelogالعربيةDashboard
DocumentationAPI reference
API referenceWhatsApp
  • Introduction
  • Authentication
    • GETVerify API key
  • Agents
    • POSTCreate agent
    • GETList agents
    • GETGet agent
    • PUTUpdate agent
    • DELDelete agent
    • POSTLink analysis groups to an agent
    • GETList analysis groups for an agent
  • Tools
    • POSTCreate tool
    • GETList tools
    • GETGet tool
    • PUTUpdate tool
    • DELDelete tool
    • POSTLink a tool to an agent
    • DELUnlink a tool from an agent
    • GETList tools for an agent
    • GETList agents for a tool
  • Analysis groups
    • POSTCreate analysis group
    • GETList analysis groups
    • GETGet analysis group
    • PUTUpdate analysis group
    • DELDelete analysis group
    • POSTLink an agent to an analysis group
    • POSTLink agents to an analysis group
    • GETList agents for an analysis group
    • DELUnlink an analysis group from an agent
  • Knowledge bases
    • POSTCreate knowledge base
    • GETList knowledge bases
    • GETGet knowledge base
    • PATCHUpdate knowledge base
    • DELDelete knowledge base
  • Documents
    • POSTAdd PDF document
    • POSTAdd text document
    • POSTAdd URL document
    • GETList documents
    • GETGet document
    • DELDelete document
  • Calls
    • POSTCreate outbound call
    • GETGet call
    • POSTSearch calls
    • POSTGet call analytics
    • POSTExport calls
    • GETGet recording download URL
    • POSTCreate outbound call (legacy path)
  • Web calls
    • POSTCreate web call
    • POSTCreate web call (legacy path)
  • SIP inbound
    • POSTCreate SIP inbound trunk
    • GETList SIP inbound trunks
    • GETGet SIP inbound trunk
    • DELDelete SIP inbound trunk
  • SIP outbound
    • POSTCreate SIP outbound trunk
    • GETList SIP outbound trunks
    • GETGet SIP outbound trunk
    • DELDelete SIP outbound trunk
  • Agent inbound links
    • POSTLink an agent to an inbound trunk
    • GETList agent inbound links
    • DELDelete agent inbound link
  • Text to speech
    • POSTGenerate speech
    • GETList voices
    • GETGet voice
    • POSTClone a voice
    • DELDelete cloned voice
  • Speech to text
    • POSTTranscribe an audio file
    • GETGet transcription job
    • GETList transcription jobs
    • WSStream speech to text
  • Contacts
    • POSTCreate contact
    • GETList contacts
    • GETSearch contacts
    • GETGet contact
    • PATCHUpdate contact
    • GETList conversations for a contact
  • Conversations
    • GETList conversations
    • POSTFilter conversations
    • POSTList conversations by contact
    • GETGet conversation
    • GETList conversation messages
    • POSTSend a message
    • POSTSend a message with an attachment
    • GETList conversation attachments
    • POSTAssign conversation
    • POSTChange conversation status
    • POSTChange conversation priority
    • POSTMark conversation as seen
  • Tickets
    • POSTCreate ticket
    • GETList tickets
    • POSTFilter tickets
    • POSTList tickets by contact
    • GETGet ticket
    • GETList ticket messages
    • POSTAdd a ticket message
    • POSTAdd a ticket message with attachments
    • POSTAssign ticket
    • POSTChange ticket status
    • POSTChange ticket priority
    • POSTChange ticket type
    • POSTCreate ticket inbox
    • GETList ticket inboxes
    • PATCHUpdate ticket inbox
    • DELDelete ticket inbox
  • WhatsApp
    • POSTConnect a WhatsApp number
    • GETList WhatsApp inboxes
    • GETGet WhatsApp inbox
    • PATCHUpdate WhatsApp inbox
    • DELDelete WhatsApp inbox
    • POSTCreate WhatsApp conversation
    • GETList WhatsApp conversations
    • POSTFilter WhatsApp conversations
    • POSTList WhatsApp conversations by contact
    • POSTAssign an agent to a WhatsApp number
    • GETGet the agent on a WhatsApp number
    • DELRemove the agent from a WhatsApp number
    • POSTGet WhatsApp analytics
  • Instagram
    • GETList Instagram accounts
    • GETGet Instagram account
    • DELDelete Instagram account
    • GETList Instagram conversations
    • POSTFilter Instagram conversations
    • POSTList Instagram conversations by contact
    • POSTAssign an agent to an Instagram account
    • GETGet the agent on an Instagram account
    • DELRemove the agent from an Instagram account
  • TikTok
    • GETList TikTok accounts
    • GETGet TikTok account
    • DELDelete TikTok account
    • GETList TikTok conversations
    • POSTFilter TikTok conversations
    • POSTList TikTok conversations by contact
    • POSTAssign an agent to a TikTok account
    • GETGet the agent on a TikTok account
    • DELRemove the agent from a TikTok account

Inbox

WhatsApp

Connect WhatsApp numbers, work their conversations and put an agent on each number.

13 endpoints

  • POSTConnect a WhatsApp number/api/ext/omni_v2/whatsapp/inboxesConnect a new WhatsApp number to the project by creating a WhatsApp inbox.
  • GETList WhatsApp inboxes/api/ext/omni_v2/whatsapp/inboxesList the WhatsApp inboxes connected to the project, oldest first.
  • GETGet WhatsApp inbox/api/ext/omni_v2/whatsapp/inboxes/{inbox_id}Retrieve the full details of a single WhatsApp inbox by its id.
  • PATCHUpdate WhatsApp inbox/api/ext/omni_v2/whatsapp/inboxesUpdate the configuration of one of the project's WhatsApp inboxes, such as its WhatsApp Cloud API credentials, phone number details, webhook verify token, auto-assignment behavior, and display name.
  • DELDelete WhatsApp inbox/api/ext/omni_v2/whatsapp/inboxesDelete one of the project's WhatsApp inboxes, disconnecting that WhatsApp number from the project.
  • POSTCreate WhatsApp conversation/api/ext/omni_v2/whatsappCreate a new WhatsApp conversation (ticket) for a contact and return the full conversation object.
  • GETList WhatsApp conversations/api/ext/omni_v2/whatsappList WhatsApp conversations (tickets) on one of the project's WhatsApp numbers, with optional filtering by assignment and status, plus search by the customer's phone number or message text.
  • POSTFilter WhatsApp conversations/api/ext/omni_v2/whatsapp/filterList WhatsApp conversations on one of the project's WhatsApp numbers using a structured filter payload instead of simple query parameters.
  • POSTList WhatsApp conversations by contact/api/ext/omni_v2/whatsapp/contact/{contact_id}Lists the WhatsApp conversations of the contact identified by contact_id on one of the project's WhatsApp numbers, with optional server-side filtering in the request body and pagination via the page query parameter.
  • POSTAssign an agent to a WhatsApp number/api/ext/omni_v2/whatsapp/assign_chatbotAttach an AI agent to one of the project's WhatsApp numbers so it automatically replies to incoming WhatsApp messages on that number.
  • GETGet the agent on a WhatsApp number/api/ext/omni_v2/whatsapp/get_chatbotRetrieve the agent currently answering on one of the project's WhatsApp numbers.
  • DELRemove the agent from a WhatsApp number/api/ext/omni_v2/whatsapp/unassign_chatbotRemove the agent from one of the project's WhatsApp numbers, stopping automatic AI replies on that number.
  • POSTGet WhatsApp analytics/api/ext/omni_v2/whatsapp/analyticsGet aggregated WhatsApp conversation analytics for a date window.
PreviousDelete ticket inboxNextConnect a WhatsApp number
© 2026 Nabrah. All rights reserved.
ChangelogPrivacy PolicyTerms of Service