Batch get phone numbers

POST /v1/agents/{agentId}/telephony/phone-numbers/batch

Batch get phone numbers

cURL

curl --request POST \
  --url https://api.us.poly.ai/v1/agents/{agentId}/telephony/phone-numbers/batch \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "phoneNumbers": [
    "<string>"
  ]
}
'

200

{
  "found": [
    {
      "number": "<string>",
      "projectId": "<string>",
      "accountId": "<string>",
      "clientEnv": "<string>",
      "connectorId": "<string>"
    }
  ],
  "notFound": [
    "<string>"
  ]
}

Authorizations

X-API-KEY · string · header · required

Path Parameters

agentId · string · required

Body

application/json

Set of E.164 phone numbers to retrieve in a single call.

phoneNumbers · string[] · required

List of phone numbers to retrieve

Minimum array length: 1

Response

200

application/json

Successful response

Result of a batch phone-number lookup, partitioned into numbers that were found and numbers that weren't.

found · object[] · required

Show child attributes

notFound · string[] · required