List Conversations
View all conversations with filtering by status
Reading time: 1 minute
List Conversations
View all conversations with filtering by status.
GET
{{base_url}}/conversationsQuery Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
phone_number_id | string | Yes | Phone number ID of the sender |
searchTerm | string | No | Search by name or phone number |
status | string | No | Filter by status |
Tip: Use status=unread to display only unread conversations.
Example Request
Example Requestbash
curl -X GET "{{base_url}}/conversations?phone_number_id=123456&status=unread" \
-H "Accept: application/json" \
-H "X-Awal-Signature-256: sha256=abc..." \
-H "X-Timestamp: 1704124800" \
-H "X-Domain: your-workspace" \
-H "X-Client-ID: your-client-id"Example Response
Response200 OK
{
"status": true,
"data": [
{
"id": 1,
"phone": "96650000000",
"name": "Ahmed Mohammed",
"last_message": "Hello, how can I help?",
"last_message_type": "text",
"unread_count": 3,
"status": "unread",
"updated_at": "2024-01-20T10:30:00Z",
"created_at": "2024-01-15T09:00:00Z"
},
{
"id": 2,
"phone": "96650000001",
"name": "Fatima Ali",
"last_message": "Thank you",
"last_message_type": "text",
"unread_count": 0,
"status": "opened",
"updated_at": "2024-01-19T14:20:00Z",
"created_at": "2024-01-10T11:00:00Z"
}
],
"meta": {
"total": 50,
"unread_total": 15
}
}Related
ā Back to Conversations
View Guide