Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

PhoneNumber Resource

Public Beta
Twilio's Messaging Services API is currently available as a Public Beta product. Some features are not yet implemented and others may be changed before the product is declared as Generally Available.
Public Beta products are not covered by a Twilio SLA.

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, Copilot 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

Names in Java format
sid
sid<PN> Not PII

The 34 character unique sid of the Phone Number.

accountSid
sid<AC> Not PII

The 34 character unique sid of the Account.

serviceSid
sid<MG> Not PII

The 34 character unique sid of the Service.

dateCreated
date_time<iso8601> Not PII

The date that this resource was created.

dateUpdated
date_time<iso8601> Not PII

The date that this resource was last updated.

phoneNumber
phone_number Not PII

The E.164 format of the phone number.

countryCode
string Not PII

The 2 character ISO Country Code of the number.

capabilities
string[] Not PII

Any array of values that indicate whether the number can receive calls or messages. Possible capabilities are Voice, SMS, and MMS.

url
url Not PII

The absolute URL for this resource.

Create a PhoneNumber resource

post
https://messaging.twilio.com/v1/Services/{ServiceSid}/PhoneNumbers

Each Service can have no more than 400 phone numbers.

Parameters
Names in Java format
phoneNumberSid
Required
post sid<PN> Not PII

Phone Number SID for the Phone Number being added to the Service.

Example
        
        
        
        

        Fetch a PhoneNumber resource

        get
        https://messaging.twilio.com/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}
        Example
              
              
              
              

              Read multiple PhoneNumber resources

              get
              https://messaging.twilio.com/v1/Services/{ServiceSid}/PhoneNumbers
              Example
                    
                    
                    
                    

                    Delete a PhoneNumber resource

                    delete
                    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.

                    Example
                          
                          
                          
                          

                          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 browsing the Twilio tag on Stack Overflow.