Search + K

Command Palette

Search for a command to run...

Sign In

GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Local.json
Copy endpoint
https://api.twilio.com

Parameters

path Path Parameters

Name Type
AccountSid required

The SID of the Account that created the resources to read.

`AC${string}`

query Query Parameters

Name Type
Beta

Whether to include phone numbers new to the Twilio platform. Can be: true or false and the default is true.

boolean
FriendlyName

A string that identifies the resources to read.

string
PhoneNumber

The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.

string
Origin

Whether to include phone numbers based on their origin. Can be: twilio or hosted. By default, phone numbers of all origin are included.

string
PageSize

How many resources to return in each list page. The default is 50, and the maximum is 1000.

number
Page

The page index. This value is simply for client state.

number
PageToken

The page token. This is provided by the API.

string

Responses

200 application/json

OK

{
incoming_phone_numbers?: ApiV2010AccountIncomingPhoneNumberIncomingPhoneNumberLocal
interface ApiV2010AccountIncomingPhoneNumberIncomingPhoneNumberLocal {
account_sid?: `AC${string}` | null;
address_sid?: `AD${string}` | null;
address_requirements?: IncomingPhoneNumberLocalEnumAddressRequirement;
api_version?: string | null;
beta?: boolean | null;
capabilities?: {
mms?: boolean;
sms?: boolean;
voice?: boolean;
fax?: boolean;
}
| null
;
date_created?: string | null;
date_updated?: string | null;
friendly_name?: string | null;
identity_sid?: `RI${string}` | null;
phone_number?: string | null;
origin?: string | null;
sid?: `PN${string}` | null;
sms_application_sid?: `AP${string}` | null;
sms_fallback_method?: "GET" | "POST" | null;
sms_fallback_url?: string | null;
sms_method?: "GET" | "POST" | null;
sms_url?: string | null;
status_callback?: string | null;
status_callback_method?: "GET" | "POST" | null;
trunk_sid?: `TK${string}` | null;
uri?: string | null;
voice_receive_mode?: IncomingPhoneNumberLocalEnumVoiceReceiveMode;
voice_application_sid?: `AP${string}` | null;
voice_caller_id_lookup?: boolean | null;
voice_fallback_method?: "GET" | "POST" | null;
voice_fallback_url?: string | null;
voice_method?: "GET" | "POST" | null;
voice_url?: string | null;
emergency_status?: IncomingPhoneNumberLocalEnumEmergencyStatus;
emergency_address_sid?: `AD${string}` | null;
emergency_address_status?: IncomingPhoneNumberLocalEnumEmergencyAddressStatus;
bundle_sid?: `BU${string}` | null;
status?: string | null;
}
[]
;
end?: number;
first_page_uri?: string;
next_page_uri?: string | null;
page?: number;
page_size?: number;
previous_page_uri?: string | null;
start?: number;
uri?: string;
}