agentIdstringrequired
Batch get phone numbers
post
https://api.dev.poly.ai/v1/agents/{agentId}/telephony/phone-numbers/batch
Path Parameters
Body
application/json
Body
application/json
BatchGetPhoneNumbersBody
Set of E.164 phone numbers to retrieve in a single call.
phoneNumbersarray[string]required
List of phone numbers to retrieve
>= 1 items
Response
application/json
Response
application/json
Successful response
BatchGetPhoneNumbersResponse
Result of a batch phone-number lookup, partitioned into numbers that
were found and numbers that weren’t.
foundarray[object]required
A phone number owned by the project, plus the connector it routes incoming calls to.
Show Child Parameters
notFoundarray[string]required
post/v1/agents/{agentId}/telephony/phone-numbers/batch
Authentication
Path Parameters
Body
{
"phoneNumbers": [
"[]"
]
}
application/json
Get a specific phone number
get
https://api.dev.poly.ai/v1/agents/{agentId}/telephony/phone-numbers/{phoneNumber}
Path Parameters
agentIdstringrequired
phoneNumberstringrequired
Response
application/json
Response
application/json
Successful response
PhoneNumberResponse
A phone number owned by the project, plus the connector it routes incoming calls to.
numberstringrequired
Phone number in E.164 format
projectIdstringrequired
Project this number belongs to
accountIdstringrequired
Account this number belongs to
clientEnvstringrequired
Client environment (sandbox, pre-release, live)
connectorIdstring
Connector this number is routed to
get/v1/agents/{agentId}/telephony/phone-numbers/{phoneNumber}
Authentication
Path Parameters
application/json
Import a single phone number
post
https://api.dev.poly.ai/v1/agents/{agentId}/telephony/phone-numbers/{phoneNumber}
Path Parameters
agentIdstringrequired
phoneNumberstringrequired
Body
application/json
Body
application/json
ImportPhoneNumberBody
Import settings for a single phone number, including which environment it routes to.
clientEnvstring
Client environment (sandbox, pre-release, live)
Default:live
Response
application/json
Response
application/json
Successful response
ImportPhoneNumberResponse
The phone number that was imported.
importedstringrequired
The imported phone number
post/v1/agents/{agentId}/telephony/phone-numbers/{phoneNumber}
Authentication
Path Parameters
Body
{}
application/json
Delete a single phone number
delete
https://api.dev.poly.ai/v1/agents/{agentId}/telephony/phone-numbers/{phoneNumber}
Path Parameters
agentIdstringrequired
phoneNumberstringrequired
Response
application/json
Response
application/json
Successful response
DeletePhoneNumberResponse
The phone number that was released.
deletedstringrequired
The deleted phone number
delete/v1/agents/{agentId}/telephony/phone-numbers/{phoneNumber}
Authentication
Path Parameters
application/json
Reassign a phone number to a different connector
patch
https://api.dev.poly.ai/v1/agents/{agentId}/telephony/phone-numbers/{phoneNumber}
Path Parameters
agentIdstringrequired
phoneNumberstringrequired
Body
application/json
Body
application/json
ReassignPhoneNumberBody
Target connector for reassigning a phone number.
connectorIdstringrequired
Target connector ID to reassign the phone number to
Response
application/json
Response
application/json
Successful response
PhoneNumberResponse
A phone number owned by the project, plus the connector it routes incoming calls to.
numberstringrequired
Phone number in E.164 format
projectIdstringrequired
Project this number belongs to
accountIdstringrequired
Account this number belongs to
clientEnvstringrequired
Client environment (sandbox, pre-release, live)
connectorIdstring
Connector this number is routed to
patch/v1/agents/{agentId}/telephony/phone-numbers/{phoneNumber}
Authentication
Path Parameters
Body
{
"connectorId": "connectorId"
}
application/json