Agent Telephony

Update an agent telephony binding

PATCH /agents/{agent_name}/telephony/bindings/{binding_id}

Updates a telephony binding owned by the voice agent named in the path.

Paramètres d’en-tête

Foundry-Features enum

A feature flag opt-in required when using preview operations or modifying persisted preview resources.

VoiceAgents=V1Preview

If-Match string obligatoire

The entity tag returned by the latest read. The request fails if the resource changed since that read.

Paramètres de chemin d’accès

agent_name string obligatoire

The name of the voice agent that owns the binding.

binding_id string obligatoire

The service-generated binding identifier.

Paramètres de la requête

api-version string obligatoire

The API version to use for this operation.

Corps de la demande

The binding properties to update.

Content-Type: application/merge-patch+json

status string | enum

The lifecycle status of a telephony binding.

Un des éléments suivants :

string

enum

activesuspended

label string | null

The replacement display label. Omit it to preserve the current value; use null to clear it.

connection_name string

The replacement Foundry connection name. This property is valid only for a Teams Phone Extension binding; a Twilio binding's connection is immutable.

phone_number string | null

The replacement Teams Phone Extension display phone number. Omit it to preserve the current value; use null to clear it. This property is valid only for a Teams Phone Extension binding.

Réponses

The request has succeeded.

En-têtes

ETag string obligatoire

The entity tag to send in the If-Match header when updating or deleting the binding.

Corps

Content-Type: application/json

Celui-ci peut avoir l'une des valeurs suivantes :

teams_phone_extension TeamsPhoneExtensionTelephonyBinding

A Microsoft Teams Phone Extension binding owned by a voice agent.

provider enum obligatoire

The Microsoft Teams Phone Extension provider.

teams_phone_extension

phone_number string

The optional display phone number for the Teams resource account.

resource_account_object_id string obligatoire

Universally Unique Identifier

twilio TwilioTelephonyBinding

A Twilio binding owned by a voice agent.

provider enum obligatoire

The Twilio provider.

twilio

phone_number string obligatoire

The Twilio E.164 phone number.

Requête

PATCH /agents/{agent_name}/telephony/bindings/{binding_id} HTTP/1.1

Response

Status: 200
Content-Type: application/json

Status: 4XX
Content-Type: application/json

Status: 5XX
Content-Type: application/json