List incoming phone number toll free
Incoming toll free phone numbers on a Twilio account/project
Path parameters
-
The SID of the Account that created the resources to read.
Query parameters
-
Beta boolean
Whether to include phone numbers new to the Twilio platform. Can be:
true
orfalse
and the default istrue
. -
FriendlyName string
A string that identifies the resources to read.
-
PhoneNumber string(phone-number)
The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.
-
Origin string
Whether to include phone numbers based on their origin. Can be:
twilio
orhosted
. By default, phone numbers of all origin are included. -
PageSize integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Minimum value is
1
, maximum value is1000
.
GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/TollFree.json
curl \
-X GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/TollFree.json \
--user "username:password"
Response examples (200)
{
"end": 42,
"first_page_uri": "https://example.com",
"incoming_phone_numbers": [
{
"account_sid": "string",
"address_requirements": "none",
"address_sid": "string",
"api_version": "string",
"beta": true,
"bundle_sid": "string",
"capabilities": {
"fax": true,
"mms": true,
"sms": true,
"voice": true
},
"date_created": "string",
"date_updated": "string",
"emergency_address_sid": "string",
"emergency_address_status": "registered",
"emergency_status": "Active",
"friendly_name": "string",
"identity_sid": "string",
"origin": "string",
"phone_number": "string",
"sid": "string",
"sms_application_sid": "string",
"sms_fallback_method": "HEAD",
"sms_fallback_url": "https://example.com",
"sms_method": "HEAD",
"sms_url": "https://example.com",
"status": "string",
"status_callback": "https://example.com",
"status_callback_method": "HEAD",
"trunk_sid": "string",
"uri": "https://example.com",
"voice_application_sid": "string",
"voice_caller_id_lookup": true,
"voice_fallback_method": "HEAD",
"voice_fallback_url": "https://example.com",
"voice_method": "HEAD",
"voice_receive_mode": "voice",
"voice_url": "https://example.com"
}
],
"next_page_uri": "https://example.com",
"page": 42,
"page_size": 42,
"previous_page_uri": "https://example.com",
"start": 42,
"uri": "https://example.com"
}
Response examples (200)
{
"end": 42,
"first_page_uri": "https://example.com",
"incoming_phone_numbers": [
{
"account_sid": "string",
"address_requirements": "none",
"address_sid": "string",
"api_version": "string",
"beta": true,
"bundle_sid": "string",
"capabilities": {
"fax": true,
"mms": true,
"sms": true,
"voice": true
},
"date_created": "string",
"date_updated": "string",
"emergency_address_sid": "string",
"emergency_address_status": "registered",
"emergency_status": "Active",
"friendly_name": "string",
"identity_sid": "string",
"origin": "string",
"phone_number": "string",
"sid": "string",
"sms_application_sid": "string",
"sms_fallback_method": "HEAD",
"sms_fallback_url": "https://example.com",
"sms_method": "HEAD",
"sms_url": "https://example.com",
"status": "string",
"status_callback": "https://example.com",
"status_callback_method": "HEAD",
"trunk_sid": "string",
"uri": "https://example.com",
"voice_application_sid": "string",
"voice_caller_id_lookup": true,
"voice_fallback_method": "HEAD",
"voice_fallback_url": "https://example.com",
"voice_method": "HEAD",
"voice_receive_mode": "voice",
"voice_url": "https://example.com"
}
],
"next_page_uri": "https://example.com",
"page": 42,
"page_size": 42,
"previous_page_uri": "https://example.com",
"start": 42,
"uri": "https://example.com"
}