Skip to main content
PATCH
/
update-phone-number
/
{phone_number}
JavaScript
import Retell from 'retell-sdk';

const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
});

const phoneNumberResponse = await client.phoneNumber.update('+14157774444', {
  inbound_agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
  nickname: 'Frontdesk Number',
  outbound_agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
});

console.log(phoneNumberResponse.inbound_agent_id);
{
  "phone_number": "+14157774444",
  "phone_number_type": "retell-twilio",
  "last_modification_timestamp": 1703413636133,
  "phone_number_pretty": "+1 (415) 777-4444",
  "inbound_agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
  "outbound_agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
  "inbound_agent_version": 1,
  "outbound_agent_version": 1,
  "inbound_allowed_countries": [
    "US",
    "CA",
    "GB"
  ],
  "outbound_allowed_countries": [
    "US",
    "CA"
  ],
  "area_code": 415,
  "nickname": "Frontdesk Number",
  "inbound_webhook_url": "https://example.com/inbound-webhook"
}

Authorizations

​
Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Path Parameters

​
phone_number
string
required

E.164 format of the number (+country code, then number with no space, no special characters), used as the unique identifier for phone number APIs.

Example:

"+14157774444"

Body

application/json
​
inbound_agent_id
string | null

Unique id of agent to bind to the number. The number will automatically use the agent when receiving inbound calls. If set to null, this number would not accept inbound call.

Example:

"oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD"

​
outbound_agent_id
string | null

Unique id of agent to bind to the number. The number will automatically use the agent when conducting outbound calls. If set to null, this number would not be able to initiate outbound call without agent id override.

Example:

"oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD"

​
inbound_agent_version
integer | null

Version of the inbound agent to bind to the number. If not provided, will default to latest version.

Example:

1

​
outbound_agent_version
integer | null

Version of the outbound agent to bind to the number. If not provided, will default to latest version.

Example:

1

​
nickname
string | null

Nickname of the number. This is for your reference only.

Example:

"Frontdesk Number"

​
inbound_webhook_url
string | null

If set, will send a webhook for inbound calls, where you can to override agent id, set dynamic variables and other fields specific to that call.

Example:

"https://example.com/inbound-webhook"

​
inbound_allowed_countries
string[] | null

List of ISO 3166-1 alpha-2 country codes from which inbound calls are allowed. If not set or empty, calls from all countries are allowed.

Example:
["US", "CA", "GB"]
​
outbound_allowed_countries
string[] | null

List of ISO 3166-1 alpha-2 country codes to which outbound calls are allowed. If not set or empty, calls to all countries are allowed.

Example:
["US", "CA"]
​
termination_uri
string

The termination uri to update for the phone number. This is used for outbound calls.

Example:

"someuri.pstn.twilio.com"

​
auth_username
string

The username used for authentication for the SIP trunk to update for the phone number.

Example:

"username"

​
auth_password
string

The password used for authentication for the SIP trunk to update for the phone number.

Example:

"123456"

​
transport
string | null

Outbound transport protocol to update for the phone number. Valid values are "TLS", "TCP" and "UDP". Default is "TCP".

Example:

"TCP"

Response

Successfully updated an phone number object.

​
phone_number
string
required

E.164 format of the number (+country code, then number with no space, no special characters), used as the unique identifier for phone number APIs.

Example:

"+14157774444"

​
phone_number_type
enum<string>
required

Type of the phone number.

Available options:
retell-twilio,
retell-telnyx,
custom
Example:

"retell-twilio"

​
last_modification_timestamp
integer
required

Last modification timestamp (milliseconds since epoch). Either the time of last update or creation if no updates available.

Example:

1703413636133

​
phone_number_pretty
string

Pretty printed phone number, provided for your reference.

Example:

"+1 (415) 777-4444"

​
inbound_agent_id
string | null

Unique id of agent to bind to the number. The number will automatically use the agent when receiving inbound calls. If null, this number would not accept inbound call.

Example:

"oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD"

​
outbound_agent_id
string | null

Unique id of agent to bind to the number. The number will automatically use the agent when conducting outbound calls. If null, this number would not be able to initiate outbound call without agent id override.

Example:

"oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD"

​
inbound_agent_version
integer | null

Version of the inbound agent to bind to the number. If not provided, will default to latest version.

Example:

1

​
outbound_agent_version
integer | null

Version of the outbound agent to bind to the number. If not provided, will default to latest version.

Example:

1

​
inbound_allowed_countries
string[] | null

List of ISO 3166-1 alpha-2 country codes from which inbound calls are allowed. If not set or empty, calls from all countries are allowed.

Example:
["US", "CA", "GB"]
​
outbound_allowed_countries
string[] | null

List of ISO 3166-1 alpha-2 country codes to which outbound calls are allowed. If not set or empty, calls to all countries are allowed.

Example:
["US", "CA"]
​
area_code
integer

Area code of the number to obtain. Format is a 3 digit integer. Currently only supports US area code.

Example:

415

​
nickname
string | null

Nickname of the number. This is for your reference only.

Example:

"Frontdesk Number"

​
inbound_webhook_url
string | null

If set, will send a webhook for inbound calls, where you can to override agent id, set dynamic variables and other fields specific to that call.

Example:

"https://example.com/inbound-webhook"