Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

Menu

Expand
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?

Messaging Short Codes

A short code is a 5 or 6-digit number that can send and receive messages with mobile phones. These high-throughput numbers are perfect for apps that need to send messages to lots of users or need to send time-sensitive messages. You can buy shortcodes from Twilio or port existing short codes to our platform.

To send messages from your short code, see the Sending Messages documentation.

ShortCode properties

Names in PHP format
accountSid
sid<AC> Not PII

The SID of the Account that created this ShortCode resource.

apiVersion
string Not PII

The API version used to start a new TwiML session when an SMS message is sent to this short code.

dateCreated
date_time<rfc2822> Not PII

The date and time in GMT that this resource was created specified in RFC 2822 format.

dateUpdated
date_time<rfc2822> Not PII

The date and time in GMT that this resource was last updated, specified in RFC 2822 format.

friendlyName
string Not PII

A string that you assigned to describe this resource. By default, the FriendlyName is the short code.

shortCode
string Not PII

The short code. e.g., 894546.

sid
sid<SC> Not PII

The unique string that that we created to identify this ShortCode resource.

smsFallbackMethod
http_method Not PII

The HTTP method we use to call the sms_fallback_url. Can be: GET or POST.

smsFallbackUrl
url Not PII

The URL that we call if an error occurs while retrieving or executing the TwiML from sms_url.

smsMethod
http_method Not PII

The HTTP method we use to call the sms_url. Can be: GET or POST.

smsUrl
url Not PII

The URL we call when receiving an incoming SMS message to this short code.

uri
uri Not PII

The URI of this resource, relative to https://api.twilio.com.

Fetch a ShortCode resource

get
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes/{Sid}.json
Parameters
Names in None format
account_sid
Required
get sid<AC> Not PII

The SID of the Account that created the ShortCode resource(s) to fetch.

sid
Required
get sid<SC> Not PII

The Twilio-provided string that uniquely identifies the ShortCode resource to fetch

Example
        
        
        
        

        Read multiple ShortCode resources

        get
        https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes.json

        Returns a list of ShortCode resources, each representing a short code within your account. This list includes paging information.

        Filter the list Twilio returns

        The following query string parameters allow you to limit the list returned.

        Parameters
        Names in None format
        friendly_name
        Optional
        get string Not PII

        The string that identifies the ShortCode resources to read.

        short_code
        Optional
        get string Not PII

        Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit.

        account_sid
        Required
        get sid<AC> Not PII

        The SID of the Account that created the ShortCode resource(s) to read.

        Example 1
              
              
              
              
              Example 2
                    
                    
                    
                    
                    Return the set of short codes that match '67898'

                    Read: list Short Codes with an exact match

                    Return the set of short codes that match '67898'
                    Example 3
                          
                          
                          
                          
                          Return the set of all phone numbers containing the digits '898'

                          Read: list all Short Codes with a partial match

                          Return the set of all phone numbers containing the digits '898'

                          Update a ShortCode resource

                          post
                          https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes/{Sid}.json

                          Tries to update the shortcode's properties. This API call returns the updated resource representation if it is successful. The returned response is identical to that returned when making a GET request.

                          Parameters
                          Names in None format
                          account_sid
                          Required
                          post sid<AC> Not PII

                          The SID of the Account that created the ShortCode resource(s) to update.

                          sid
                          Required
                          post sid<SC> Not PII

                          The Twilio-provided string that uniquely identifies the ShortCode resource to update

                          friendly_name
                          Optional
                          post string Not PII

                          A descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the FriendlyName is the short code.

                          api_version
                          Optional
                          post string Not PII

                          The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01.

                          sms_url
                          Optional
                          post url Not PII

                          The URL we should call when receiving an incoming SMS message to this short code.

                          sms_method
                          Optional
                          post http_method Not PII

                          The HTTP method we should use when calling the sms_url. Can be: GET or POST.

                          sms_fallback_url
                          Optional
                          post url Not PII

                          The URL that we should call if an error occurs while retrieving or executing the TwiML from sms_url.

                          sms_fallback_method
                          Optional
                          post http_method Not PII

                          The HTTP method that we should use to call the sms_fallback_url. Can be: GET or POST.

                          Example 1
                                
                                
                                
                                
                                Set the SMS Url on a short code to 'http://demo.twilio.com/docs/sms.xml'

                                Update: Change a short code parameter

                                Set the SMS Url on a short code to 'http://demo.twilio.com/docs/sms.xml'
                                Rate this page:

                                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.