List purchased phone numbers for new assistants
Returns the purchased phone numbers your organization can give a new
assistant: numbers your instance allocated to the organization that no
assistant uses yet. Send a number's id as phone_number_id when
creating an assistant. The list is empty when the organization has
none. Without phone_number_id, the platform allocates a number,
except for organizations that route calls through their own assigned
carrier: they must send a phone_number_id from this list. Ordered by
number.
Authorization
bearerAuth API key in the Authorization: Bearer <key> header.
Keys are created in the SMAO dashboard (Settings → API Keys).
In: header
Query Parameters
Opaque cursor from a prior meta.next_cursor. Base64url-encoded
(unpadded) - do not parse or construct it manually. A value that is not
base64url is rejected with validation_failed, and so is a
/phone-numbers cursor without a phone number; any other value that does
not decode to a list position (a timestamp and a row id) restarts at the
first page.
^[A-Za-z0-9_-]+$Items per page (1–100, default 50).
1 <= value <= 10050Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/phone-numbers"{ "data": [ { "id": "string", "phone_number": "string", "account_label": "string" } ], "meta": { "has_more": true, "next_cursor": "string" }}