WhatsApp
List Phones

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"
    }
  ]
}
FieldDescription
chat_idPass this as {session_id} to Send Message
nameDisplay name set when the session was created
statusopen = connected and ready. Other values: close, connecting, created
phone_numberThe WhatsApp number linked to this session

Only sessions with status: "open" can send messages.


Error Responses

StatusDescription
401 UnauthorizedMissing or invalid API key