SautiDesk
SautiDesk API
Channels and templates

List connected WhatsApp numbers

GET
/v1/desk/whatsapp/numbers

Lists the WhatsApp numbers connected to the workspace. Use it to choose which number the desk uses.

Requires: desk.read scope, Converse licence.

Authorization

bearerAuth
AuthorizationBearer <token>

A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.

In: header

Query Parameters

cursor?string

next_cursor from the previous page. Leave it out for the first page.

limit?integer

Page size: 100 by default, 100 at most.

Response

OK

Example

{  "data": [    {      "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37",      "e164": "+254712345678",      "label": "Amina Wanjiru",      "ours": false,      "phone_number_id": "cfe03fe0-f54f-4f29-9e10-0d48d28829af",      "state": "available",      "connected": false,      "trial": false,      "calling_blocked_reason": "Calling is not switched on for this workspace"    }  ],  "next_cursor": "eyJvIjoyNX0",  "has_more": false}
FieldTypeDescription
datarequiredobject[]
idrequiredstring (uuid)
e164requiredstring
labelrequiredstringA short name to recognise it by.
oursrequiredboolean
phone_number_idstring
statestringThe availability to set: available, away, break, non_phone or offline.
connectedrequiredboolean
trialrequiredboolean
calling_blocked_reasonstring
next_cursorrequiredstring | null
has_morerequiredboolean
curl -X GET "https://api.sautidesk.com/v1/desk/whatsapp/numbers"