Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Messaging Service PhoneNumber Resource


(warning)

Public Beta

The Service Resource is currently available as a Public Beta product. This means that some features for configuring your Messaging Service via the REST API are not yet implemented, and others may be changed before the product is declared Generally Available. Messaging Service Configuration through the Twilio Console(link takes you to an external page) is Generally Available.

Public Beta products are not covered by a Twilio SLA(link takes you to an external page).

The resources for sending Messages with a Messaging Service are Generally Available.

The PhoneNumber subresource of a Service instance represents a phone number you have associated to the Service.

When sending a message with your Messaging Service, Twilio will select a phone number from the service for delivery.

Inbound messages received on any phone number associated to a Messaging Service are passed to the inbound request URL of the Service with the TWiML parameters that describe the message.


PhoneNumber Properties

phonenumber-properties page anchor
Resource properties
sidtype: SID<PN>Not PII

The unique string that we created to identify the PhoneNumber resource.


account_sidtype: SID<AC>Not PII

The SID of the Account(link takes you to an external page) that created the PhoneNumber resource.


service_sidtype: SID<MG>Not PII

The SID of the Service(link takes you to an external page) the resource is associated with.


date_createdtype: string<DATE TIME>Not PII

The date and time in GMT when the resource was created specified in ISO 8601(link takes you to an external page) format.


date_updatedtype: string<DATE TIME>Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601(link takes you to an external page) format.


phone_numbertype: string<PHONE NUMBER>Not PII

The phone number in E.164(link takes you to an external page) format, which consists of a + followed by the country code and subscriber number.


country_codetype: stringNot PII

capabilitiestype: string[]Not PII

An array of values that describe whether the number can receive calls or messages. Can be: Voice, SMS, and MMS.


urltype: string<URI>Not PII

The absolute URL of the PhoneNumber resource.


Create a PhoneNumber Resource (Add a Phone Number to a Messaging Service)

create-a-phonenumber-resource-add-a-phone-number-to-a-messaging-service page anchor
POST https://messaging.twilio.com/v1/Services/{ServiceSid}/PhoneNumbers

Add a Phone Number to your Messaging Service by creating a PhoneNumber resource.

Each Service can have no more than 400 phone numbers by default. If you think you might need a higher limit, contact Twilio Support(link takes you to an external page) about a Messaging Service number limit increase, and include an explanation of your use case.

Parameters

create-parameters page anchor
URI parameters
ServiceSidtype: SID<MG>Not PII
Path Parameter

The SID of the Service(link takes you to an external page) to create the resource under.


Request body parameters
PhoneNumberSidtype: SID<PN>Not PII
Required

The SID of the Phone Number being added to the Service.

Add a Phone Number to a Messaging Service

add-a-phone-number-to-a-messaging-service page anchor

Create a PhoneNumber Resource to add it to a Messaging Service

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_13
// Download the helper library from https://www.twilio.com/docs/node/install
_13
// Find your Account SID and Auth Token at twilio.com/console
_13
// and set the environment variables. See http://twil.io/secure
_13
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_13
const authToken = process.env.TWILIO_AUTH_TOKEN;
_13
const client = require('twilio')(accountSid, authToken);
_13
_13
client.messaging.v1.services('MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_13
.phoneNumbers
_13
.create({
_13
phoneNumberSid: 'PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
_13
})
_13
.then(phone_number => console.log(phone_number.sid));

Output

_11
{
_11
"sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11
"service_sid": "MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11
"date_created": "2015-07-30T20:12:31Z",
_11
"date_updated": "2015-07-30T20:12:33Z",
_11
"phone_number": "+987654321",
_11
"country_code": "US",
_11
"capabilities": [],
_11
"url": "https://messaging.twilio.com/v1/Services/MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/PhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_11
}


Fetch a PhoneNumber resource

fetch-a-phonenumber-resource page anchor
GET https://messaging.twilio.com/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}

URI parameters
ServiceSidtype: SID<MG>Not PII
Path Parameter

The SID of the Service(link takes you to an external page) to fetch the resource from.


Sidtype: stringNot PII
Path Parameter

The SID of the PhoneNumber resource to fetch.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.messaging.v1.services('MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.phoneNumbers('PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.fetch()
_11
.then(phone_number => console.log(phone_number.sid));

Output

_11
{
_11
"sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11
"service_sid": "MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11
"date_created": "2015-07-30T20:12:31Z",
_11
"date_updated": "2015-07-30T20:12:33Z",
_11
"phone_number": "12345",
_11
"country_code": "US",
_11
"capabilities": [],
_11
"url": "https://messaging.twilio.com/v1/Services/MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/PhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_11
}


Read multiple PhoneNumber resources

read-multiple-phonenumber-resources page anchor
GET https://messaging.twilio.com/v1/Services/{ServiceSid}/PhoneNumbers

URI parameters
ServiceSidtype: SID<MG>Not PII
Path Parameter

The SID of the Service(link takes you to an external page) to read the resources from.


PageSizetype: integerNot PII
Query Parameter

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


Pagetype: integerNot PII
Query Parameter

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


PageTokentype: stringNot PII
Query Parameter

The page token. This is provided by the API.

List multiple PhoneNumbers

list-multiple-phonenumbers page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.messaging.v1.services('MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.phoneNumbers
_11
.list({limit: 20})
_11
.then(phoneNumbers => phoneNumbers.forEach(p => console.log(p.sid)));

Output

_24
{
_24
"meta": {
_24
"page": 0,
_24
"page_size": 20,
_24
"first_page_url": "https://messaging.twilio.com/v1/Services/MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/PhoneNumbers?PageSize=20&Page=0",
_24
"previous_page_url": "https://messaging.twilio.com/v1/Services/MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/PhoneNumbers?PageSize=20&Page=0",
_24
"next_page_url": "https://messaging.twilio.com/v1/Services/MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/PhoneNumbers?PageSize=20&Page=1",
_24
"key": "phone_numbers",
_24
"url": "https://messaging.twilio.com/v1/Services/MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/PhoneNumbers?PageSize=20&Page=0"
_24
},
_24
"phone_numbers": [
_24
{
_24
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_24
"service_sid": "MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_24
"sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_24
"date_created": "2015-07-30T20:12:31Z",
_24
"date_updated": "2015-07-30T20:12:33Z",
_24
"phone_number": "+987654321",
_24
"country_code": "US",
_24
"capabilities": [],
_24
"url": "https://messaging.twilio.com/v1/Services/MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/PhoneNumbers/PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_24
}
_24
]
_24
}


Delete a PhoneNumber resource

delete-a-phonenumber-resource page anchor
DELETE https://messaging.twilio.com/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}

(warning)

Warning

Removing a phone number from the Service does not release the number from your account. You must release a phone number from your Account to disassociate and delete the phone number from the Service.

Returns a "204 NO CONTENT" if the phone number was successfully removed from the service.

URI parameters
ServiceSidtype: SID<MG>Not PII
Path Parameter

The SID of the Service(link takes you to an external page) to delete the resource from.


Sidtype: stringNot PII
Path Parameter

The SID of the PhoneNumber resource to delete.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.messaging.v1.services('MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.phoneNumbers('PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.remove();


Rate this page: