General Documentation
Agents
Agent Executions
Test Suites
Projects
WhatsApp Conversations
Customers
WhatsApp Configs
Agent Test Chats
Conversation Assignments
WhatsApp Templates
WhatsApp Contact Notes
Agent Snapshots
WhatsApp Messages
List messages in a WhatsApp conversation
Returns a list of messages for a specific WhatsApp conversation
GET
/
whatsapp_conversations
/
{conversation_id}
/
whatsapp_messages
Copy
curl --request GET \
--url https://app.kapso.ai/api/v1/whatsapp_conversations/{conversation_id}/whatsapp_messages \
--header 'X-API-Key: <api-key>'
Copy
{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone_number": "<string>",
"message_type": "text",
"content": "<string>",
"direction": "inbound",
"status": "<string>",
"processing_status": "pending",
"whatsapp_message_id": "<string>",
"metadata": {},
"media_url": "<string>",
"message_type_data": {
"text": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"page": 123,
"per_page": 123,
"total_pages": 123,
"total_count": 123
}
}
Authorizations
API key required for all endpoints
Path Parameters
Query Parameters
Required range:
x >= 1
Required range:
1 <= x <= 100
Response
200
application/json
A list of WhatsApp messages
The response is of type object
.
Copy
curl --request GET \
--url https://app.kapso.ai/api/v1/whatsapp_conversations/{conversation_id}/whatsapp_messages \
--header 'X-API-Key: <api-key>'
Copy
{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone_number": "<string>",
"message_type": "text",
"content": "<string>",
"direction": "inbound",
"status": "<string>",
"processing_status": "pending",
"whatsapp_message_id": "<string>",
"metadata": {},
"media_url": "<string>",
"message_type_data": {
"text": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"page": 123,
"per_page": 123,
"total_pages": 123,
"total_count": 123
}
}
Assistant
Responses are generated using AI and may contain mistakes.