List Phones
Returns all WhatsApp sessions (phones) registered to your organisation. Use the chat_id from this response as {session_id} when calling Send Message.
Endpoint
GET /v1/whatsapp/phones/Authentication: Bearer API key
Request
curl https://api.talkntalk.africa/v1/whatsapp/phones/ \
-H "Authorization: Bearer tk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"Response
200 OK
{
"phones": [
{
"chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Marketing Line",
"status": "open",
"phone_number": "254712345678"
}
]
}| Field | Description |
|---|---|
chat_id | Pass this as {session_id} to Send Message |
name | Display name set when the session was created |
status | open = connected and ready. Other values: close, connecting, created |
phone_number | The WhatsApp number linked to this session |
Only sessions with
status: "open"can send messages.
Error Responses
| Status | Description |
|---|---|
401 Unauthorized | Missing or invalid API key |