NOTE: The order of the columns in the CSV is not defined and may change when new fields are added to the API response. Your application design should be resilient to changes in the order of the columns in the CSV response.
An OutgoingCallerId instance resource represents a single verified number that may be used as a caller ID when making outgoing calls via the REST API and within the TwiML <Dial> verb. The OutgoingCallerIds list resource represents the set of an account's verified phone numbers.
A 34 character string that uniquely identifies this resource.
DateCreated
The date that this resource was created, given in RFC 2822 format.
DateUpdated
The date that this resource was last updated, given in RFC 2822 format.
FriendlyName
A human readable descriptive text for this resource, up to 64 characters long. By default, the FriendlyName is a nicely formatted version of the phone number.
AccountSid
The unique ID of the Account responsible for this Caller Id.
PhoneNumber
The incoming phone number. Formatted with a '+' and country code e.g., +16175551212 (E.164 format).
Uri
The URI for this resource, relative to https://api.twilio.com.
HTTP GET
Get Outgoing Caller ID Details
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl
_18
// Download the helper library from https://www.twilio.com/docs/node/install
_18
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18
// Find your Account SID and Auth Token at twilio.com/console
_18
// and set the environment variables. See http://twil.io/secure
Returns a list of OutgoingCallerId resource representations, each representing a Caller ID number valid for an account. The list includes paging information.
List Filters
The following GET query string parameters allow you to limit the list returned. Note, parameters are case-sensitive:
Parameter
Description
PhoneNumber
Only show the caller id resource that exactly matches this phone number.
FriendlyName
Only show the caller id resource that exactly matches this name.
List an Account's Outgoing Caller IDs
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl
_16
// Download the helper library from https://www.twilio.com/docs/node/install
_16
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_16
_16
// Find your Account SID and Auth Token at twilio.com/console
_16
// and set the environment variables. See http://twil.io/secure
Adds a new CallerID to your account. After making this request, Twilio will return to you a validation code and Twilio will dial the phone number given to perform validation. The code returned must be entered via the phone before the CallerID is added to your account.
The following parameters are accepted:
Required Parameters
Parameter
Description
PhoneNumber
The phone number to verify. Should be formatted with a '+' and country code e.g., +16175551212 (E.164 format). Twilio will also accept unformatted US numbers e.g., (415) 555-1212, 415-555-1212.
Optional Parameters
Parameter
Description
FriendlyName
A human readable description for the new caller ID with maximum length 64 characters. Defaults to a nicely formatted version of the number.
CallDelay
The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0.
Extension
Digits to dial after connecting the verification call.
StatusCallback
A URL that Twilio will request when the verification call ends to notify your app if the verification process was successful or not. See StatusCallback parameter below.
StatusCallbackMethod
The HTTP method Twilio should use when requesting the above URL. Defaults to POST.
This will create a new CallerID validation request within Twilio, which initiates a call to the phone number provided and listens for a validation code. The validation request is represented in the response by the following properties:
Response Properties
Property
Description
AccountSid
The unique ID of the Account to which the Validation Request belongs.
PhoneNumber
The incoming phone number being validated, formatted with a '+' and country code e.g., +16175551212 (E.164 format).
FriendlyName
The friendly name you provided, if any.
ValidationCode
The 6 digit validation code that must be entered via the phone to validate this phone number for Caller ID.
CallSid
The unique id of the Call created for this validation attempt.
StatusCallback Parameter
After the verification call ends, Twilio makes an asynchronous HTTP request to the StatusCallback URL if you provided one in your API request. By capturing this request, you can determine when the call ended and whether or not the number called was successfully verified.
Twilio passes the same parameters to your application in its asynchronous request to the StatusCallback URL as it does in a typical status callback request. The full list of parameters and descriptions of each are in the TwiML Voice: Twilio's Request documentation.
The verification status callback request also passes these additional parameters:
Parameter
Description
VerificationStatus
Describes whether or not the person called correctly entered the validation code. Possible values are success or failed.
OutgoingCallerIdSid
If the verification process was successful, the SID value of the newly-created OutgoingCallerId resource for the verified number.
Add an Outgoing Caller ID
Here are a typical request and response. Typically, you would present the validation code from the response to the user who is trying to verify their phone number. Adding an Outgoing Caller ID via the API has the same result as verifying a number via the Twilio console.
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl
_19
// Download the helper library from https://www.twilio.com/docs/node/install
_19
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19
_19
// Find your Account SID and Auth Token at twilio.com/console
_19
// and set the environment variables. See http://twil.io/secure