[
{
"id": 123,
"phone_number": "<string>",
"provider": "<string>",
"twilio_sid": "<string>",
"is_active": true,
"capabilities": {},
"created_at": "2023-11-07T05:31:56Z",
"friendly_name": "<string>",
"is_verified_caller_id": false,
"sip_trunk_id": "<string>",
"allowed_country_codes": [
"<string>"
],
"assistant": {
"id": 123,
"name": "<string>",
"is_active": true
},
"flow": {
"id": 123,
"name": "<string>",
"is_active": true
},
"updated_at": "2023-11-07T05:31:56Z"
}
]Organization
List Available Phone Numbers
List phone numbers available for assignment (not assigned to any assistant).
GET
/
api
/
v1
/
assistants
/
organization
/
phone-numbers
/
available
[
{
"id": 123,
"phone_number": "<string>",
"provider": "<string>",
"twilio_sid": "<string>",
"is_active": true,
"capabilities": {},
"created_at": "2023-11-07T05:31:56Z",
"friendly_name": "<string>",
"is_verified_caller_id": false,
"sip_trunk_id": "<string>",
"allowed_country_codes": [
"<string>"
],
"assistant": {
"id": 123,
"name": "<string>",
"is_active": true
},
"flow": {
"id": 123,
"name": "<string>",
"is_active": true
},
"updated_at": "2023-11-07T05:31:56Z"
}
]This endpoint is a convenient way to retrieve a list of all phone numbers in your organization that are not currently assigned to an assistant. This is useful for finding numbers that are available to be linked to a new or existing assistant.
This endpoint takes no parameters.
Response
The response is a JSON array of phone number objects. Theassistant field for each object will be null.
Response
[
{
"id": 2,
"phone_number": "+15557654321",
"friendly_name": "Sales Department",
"provider": "telnyx",
"twilio_sid": "PNyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy",
"is_active": true,
"is_verified_caller_id": false,
"capabilities": { "voice": true, "sms": false, "mms": false },
"sip_trunk_id": null,
"allowed_country_codes": null,
"assistant": null,
"flow": null,
"created_at": "2023-10-02T12:00:00Z",
"updated_at": null
}
]
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
200 - application/json
Successful Response
Show child attributes
Show child attributes
Minimal assistant info for phone number list.
Show child attributes
Show child attributes
ConversationFlow information for phone number responses.
Show child attributes
Show child attributes
⌘I