Conversations
Retrieve messages from a conversation with comprehensive filtering and search capabilities.
Default Behavior
- Action: Defaults to
conversation-messagesif not specified - Order: Returns newest messages first (
ascending=false) - Limit: Returns 10 messages per page by default
- Page: Starts at page 1
Search Capabilities
- Text Search: Use
queryparameter with comma-separated terms - Order Search: Use
orderIdto search by Shopify order ID - Combined Search: Use both
queryandorderIdtogether
action query parameter.Available Actions
Action: Get Conversation Messages
Fetch messages from a specific conversation. This is the default action.Basic Usage
Paginated Results
Search Messages by Text
Search by Shopify Order ID
Action: List Contacts
Retrieve a paginated list of all contacts for your organization.Get All Contacts
Paginated Contacts
Search Contacts by Name/Phone
Action: Find Contact by Phone
Look up a specific contact using their phone number.Reference Tables
Message Sender Types
Message Status
Media Types
Bot Status Values
Authorizations
Bearer token for authentication. Format: Bearer YOUR_BEARER_TOKEN
Query Parameters
API action to perform
conversation-messages, contacts, find-by-phone WhatsApp phone number (required for message and find-by-phone actions)
Contact UUID (alternative to whatsappNumber)
Number of items per page (messages: default 10, contacts: default 50)
1 <= x <= 100Page number for pagination
x >= 1Search terms (comma-separated for multiple terms)
Shopify order ID to search for (fetches order number from Shopify)
Message order (false = newest first, true = oldest first)
Search contacts by name/phone (for contacts action)
Response
Successful response
- Option 1
- Option 2
- Option 3
Whether the request was successful
true
Array of conversation messages
Number of messages returned in this response
x >= 010
Whether search filtering was applied
true
Search terms that were applied (if any)
Whether messages were stored in contact record
false

