Agent

Enable or disable phone number

Changed on

Pause or resume a phone number without disconnecting it from the agent

patch/projects/{project_id}/agent/phones/{id}

Request

  • Base URL
    https://api.beyondwords.io/v1
  • URL
    https://api.beyondwords.io/v1/projects/{project_id}/agent/phones/{id}
  • Auth
    API key in header X-Api-Key

Request body

enabledboolean required

Response

disables the phone number without removing it

idstring

Unique identifier for the phone number

typestring

The channel type. Currently always telephony.

providerstring

The telephony provider. Currently always twilio.

labelstring

A human-readable label for the phone number

phone_numberstring

The phone number in E.164 format

elevenlabs_channel_idstring

The identifier of the phone number in ElevenLabs

enabledboolean

Whether the agent currently answers calls on this number. Disabling it detaches the number from the agent in ElevenLabs without deleting the number itself.

created_atstring date-time

Time at which the object was created (ISO 8601)

Changes