Phone number management. Provision, configure, and assign phone numbers to agents for inbound/outbound calling.
List Phone Numbers
List all phone numbers with filtering and pagination.
Features:
- DateTime filtering with
createdAtGt,createdAtLt,createdAtGe,createdAtLe(and snake_case) - DateTime filtering with
updatedAtGt,updatedAtLt,updatedAtGe,updatedAtLe(and snake_case) - Sort order with
sortOrder(ASC/DESC) - Multi-ID filtering with
id_any - Higher pagination limits (up to 1000)
- Tags filtering with
tagsandtags_match
query Parameters
organization_idFilter by organization ID. If not provided, returns phone numbers for your organization.
createdAtGtFilter records created after this datetime (ISO 8601). Example: 2024-01-01T00:00:00Z
createdAtLtFilter records created before this datetime (ISO 8601). Example: 2024-12-31T23:59:59Z
createdAtGeFilter records created on or after this datetime (ISO 8601). Example: 2024-01-01T00:00:00Z
createdAtLeFilter records created on or before this datetime (ISO 8601). Example: 2024-12-31T23:59:59Z
updatedAtGtFilter records updated after this datetime (ISO 8601). Example: 2024-01-01T00:00:00Z
updatedAtLtFilter records updated before this datetime (ISO 8601). Example: 2024-12-31T23:59:59Z
updatedAtGeFilter records updated on or after this datetime (ISO 8601). Example: 2024-01-01T00:00:00Z
updatedAtLeFilter records updated on or before this datetime (ISO 8601). Example: 2024-12-31T23:59:59Z
sortOrderSort order: ASC (oldest first) or DESC (newest first). Defaults to DESC.
Sort order for list endpoints
id_anyFilter by phone number IDs (comma-separated). Example: uuid1,uuid2
tagsFilter by tags (comma-separated). Example: sales,support
tags_matchTag matching mode: 'any' (has ANY of the tags) or 'all' (has ALL tags)
skipNumber of records to skip for pagination. Defaults to 0.
limitMaximum number of records to return. Defaults to 100. Max 1000.
searchSearch by phone number (partial match supported).
List Phone Numbers › Responses
Successful Response
Pagination metadata in API responses.
Register Phone Number
Register a new phone number for use with AI agents.
Register Phone Number › Request Body
didnameRegister Phone Number › Responses
Successful Response
iddidnameorganization_idis_activeformatted_numbercapabilitiestagsinbound_webhook_secret_setGet Phone Number
Retrieve details of a specific phone number.
path Parameters
phone_number_idThe unique identifier of the phone number to retrieve.
Get Phone Number › Responses
Successful Response
iddidnameorganization_idis_activeformatted_numbercapabilitiestagsinbound_webhook_secret_setUpdate Phone Number
Update a phone number's name or agent assignment.
path Parameters
phone_number_idThe unique identifier of the phone number to update.
Update Phone Number › Responses
Successful Response
iddidnameorganization_idis_activeformatted_numbercapabilitiestagsinbound_webhook_secret_setAssign Agent to Phone Number
Assign an AI agent to handle calls for this phone number.
path Parameters
phone_number_idThe unique identifier of the phone number to assign an agent to.
Assign Agent to Phone Number › Request Body
agent_idAssign Agent to Phone Number › Responses
Successful Response
messagestatus