Inbox
The shared inbox: conversations, messages and replies, in the same place where the team answers from the dashboard. It is how you connect a helpdesk or an external bot. An API key limited to some numbers only sees those numbers' conversations.
Live inbox events
A Server-Sent Events stream of what happens in the inbox: new message, message status,
List conversations
Conversations, newest first, paged by cursor: send the answer's `nextCursor` as
Folder counts
Folder counts
Get a conversation
The conversation with the full contact and the last campaigns it received.
Update a conversation
Changes the status (close, reopen, set pending, snooze until `snoozedUntil`), assigns it
A conversation's messages
Newest first, with internal notes and events (assignment, closing) mixed in with the
Reply in a conversation
Sends a message through the conversation's number, chosen by `kind`:
Mark a conversation as read
Resets the unread counter and, if the account sends read receipts, marks the customer's last message as read on WhatsApp.
Show the typing indicator
Shows the typing indicator to the customer, with the window open and read receipts on. At most once every 20 seconds per conversation.
Upload a file for a conversation
Send the file bytes as the body (not multipart), with the name in `X-File-Name`. The
Link to an inbox file
A temporary link to download a message file, received or sent. It lasts 5 minutes; ask for another when it expires.
Team members
Who can take conversations — this is where `assignedUserId` comes from. With `phoneNumberId`, only who handles that number.