Messages
list_conversations read
Section titled “list_conversations ”List the restaurant’s recent guest SMS conversations (the Messages inbox) — who texted, their phone, and the last message. Use to see what needs a reply, or to find a guest’s number before replying with send_message.
Required scope: comms.read
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode. |
search |
string | no | Optional name/phone/text filter. |
get_conversation read
Section titled “get_conversation ”Read the full SMS conversation with one guest, by their phone number (from list_conversations). Use to get context before replying.
Required scope: comms.read
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode. |
phone |
string | yes | The guest’s phone number (E.164, from list_conversations). |
send_message write
Section titled “send_message ”Send an SMS reply to a guest — a REAL text message. Use when an owner says ‘text John that his table is ready’ or ‘reply to that guest we’re fully booked’. Pass the guest’s phone (E.164, from list_conversations) and the message. It’s delivered via the restaurant’s number and recorded in the Messages inbox. Only send what the owner asked — this reaches a real customer.
Required scope: comms.send
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode. |
to |
string | yes | Recipient phone in E.164 (e.g. +14085551234), from list_conversations. |
message |
string | yes | The SMS text to send. |
idempotencyKey |
string | no |