Search
K
Agents API

Batch get connectors by ID

post
https://api.dev.poly.ai/v1/agents/{agentId}/telephony/connectors/batch

Path Parameters

agentIdstringrequired

Body

application/json

BatchGetConnectorsBody

Set of connector IDs to retrieve in a single call.

connectorIdsarray[string]required

List of connector IDs to retrieve

>= 1 items

Response

application/json

Successful response

BatchGetConnectorsResponse

Result of a batch connector lookup, partitioned into connectors that
were found and IDs that weren’t.

foundarray[object]required

A connector: the voice, language, variant, and environment bundle
that handles incoming calls. Multiple phone numbers can share one
connector.

Show Child Parameters
notFoundarray[string]required
post/v1/agents/{agentId}/telephony/connectors/batch

Body

{ "connectorIds": [ "[]" ] }
 
application/json

Batch update connectors

patch
https://api.dev.poly.ai/v1/agents/{agentId}/telephony/connectors/batch

Path Parameters

agentIdstringrequired

Body

application/json

BatchUpdateConnectorsBody

Ordered list of connector updates.

Each update is applied independently — partial success is possible.

updatesarray[object]required

A single connector update within a batch update request.

>= 1 items

Show Child Parameters

Response

application/json

Successful response

BatchUpdateConnectorsResponse

Per-connector results from a batch update.

Each entry reports success or failure independently.

resultsarray[object]required

Result of a single connector update within a batch.

Show Child Parameters
patch/v1/agents/{agentId}/telephony/connectors/batch

Body

{ "updates": [ { "connectorId": "connectorId" } ] }
 
application/json

Look up connector by phone number

post
https://api.dev.poly.ai/v1/agents/{agentId}/telephony/connectors/lookup

Path Parameters

agentIdstringrequired

Body

application/json

LookupConnectorBody

Lookup payload for finding the connector that serves a given E.164 phone number.

phoneNumberstringrequired

Phone number to look up (E.164 format)

Response

application/json

Successful response

ConnectorResponse

A connector: the voice, language, variant, and environment bundle
that handles incoming calls. Multiple phone numbers can share one
connector.

connectorIdstringrequired

Unique connector identifier

namestringrequired

Connector display name

accountIdstringrequired

Account this connector belongs to

projectIdstringrequired

Project this connector belongs to

clientEnvstringrequired

Client environment (sandbox, pre-release, live)

variantIdstringrequired

Assigned variant ID (empty string if unassigned)

asrLangCodestringrequired

ASR language code (e.g. en-US)

ttsLangCodestringrequired

TTS language code (e.g. en-US)

voiceNamestringrequired

Google TTS voice name (e.g. en-US-Neural2-A)

disableHandoffbooleanrequired

Whether call handoff is disabled

post/v1/agents/{agentId}/telephony/connectors/lookup

Body

{ "phoneNumber": "phoneNumber" }
 
application/json

Get a connector by ID

get
https://api.dev.poly.ai/v1/agents/{agentId}/telephony/connectors/{connectorId}

Path Parameters

agentIdstringrequired
connectorIdstringrequired

Response

application/json

Successful response

ConnectorResponse

A connector: the voice, language, variant, and environment bundle
that handles incoming calls. Multiple phone numbers can share one
connector.

connectorIdstringrequired

Unique connector identifier

namestringrequired

Connector display name

accountIdstringrequired

Account this connector belongs to

projectIdstringrequired

Project this connector belongs to

clientEnvstringrequired

Client environment (sandbox, pre-release, live)

variantIdstringrequired

Assigned variant ID (empty string if unassigned)

asrLangCodestringrequired

ASR language code (e.g. en-US)

ttsLangCodestringrequired

TTS language code (e.g. en-US)

voiceNamestringrequired

Google TTS voice name (e.g. en-US-Neural2-A)

disableHandoffbooleanrequired

Whether call handoff is disabled

get/v1/agents/{agentId}/telephony/connectors/{connectorId}
 
application/json

Delete a connector and its phone numbers

delete
https://api.dev.poly.ai/v1/agents/{agentId}/telephony/connectors/{connectorId}

Path Parameters

agentIdstringrequired
connectorIdstringrequired

Response

application/json

Successful response

DeleteConnectorResponse

Summary of a connector deletion, including every phone number that
was released by the cascade.

deletedConnectorstringrequired

ID of the deleted connector

deletedPhoneNumbersarray[string]required

Phone numbers that were associated with the connector

delete/v1/agents/{agentId}/telephony/connectors/{connectorId}
 
application/json