Messaging Service PhoneNumber Resource
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 is Generally Available.
Public Beta products are not covered by a Twilio SLA.
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
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string that we created to identify the PhoneNumber resource. |
account_sid
|
The SID of the Account that created the PhoneNumber resource. |
service_sid
|
The SID of the Service the resource is associated with. |
date_created
|
The date and time in GMT when the resource was created specified in ISO 8601 format. |
date_updated
|
The date and time in GMT when the resource was last updated specified in ISO 8601 format. |
phone_number
|
The phone number in E.164 format, which consists of a + followed by the country code and subscriber number. |
country_code
|
The 2-character ISO Country Code of the number. |
capabilities
|
An array of values that describe whether the number can receive calls or messages. Can be: |
url
|
The absolute URL of the PhoneNumber resource. |
Create a PhoneNumber Resource (Add a Phone Number to a Messaging Service)
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 about a Messaging Service number limit increase, and include an explanation of your use case.
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to create the resource under. |
phone_number_sid
Required
|
The SID of the Phone Number being added to the Service. |
Example 1
Fetch a PhoneNumber resource
https://messaging.twilio.com/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to fetch the resource from. |
sid
Path
|
The SID of the PhoneNumber resource to fetch. |
Example 1
Read multiple PhoneNumber resources
https://messaging.twilio.com/v1/Services/{ServiceSid}/PhoneNumbers
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to read the resources from. |
Example 1
Delete a PhoneNumber resource
https://messaging.twilio.com/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}
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.
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to delete the resource from. |
sid
Path
|
The SID of the PhoneNumber resource to delete. |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
