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?

ShortCode 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 ShortCode subresource of a Service Resource represents the short codes you have associated to the Service.

When a short code has been added to the Messaging Service, Copilot will always attempt to prioritize message delivery with your short code when possible. If the short code cannot be used to reach your user, Copilot's Shortcode Reroute will select a phone number in your Service instead.

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

ShortCode properties

Names in PHP format
sid
sid<SC> Not PII

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

accountSid
sid<AC> Not PII

The SID of the Account that created this ShortCode resource.

serviceSid
sid<MG> Not PII

The SID of the Service this resource is associated with.

dateCreated
date_time<iso8601> Not PII

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

dateUpdated
date_time<iso8601> Not PII

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

shortCode
string Not PII

The E.164 format of the short code.

countryCode
string Not PII

The 2-character ISO Country Code of the number.

capabilities
object[] Not PII

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

url
url Not PII

The absolute URL of this ShortCode resource.

Create a ShortCode resource

post
https://messaging.twilio.com/v1/Services/{ServiceSid}/ShortCodes
Parameters
Names in None format
service_sid
Required
post sid<MG> Not PII

The SID of the Service to create the resource under.

short_code_sid
Required
post sid<SC> Not PII

SID of the ShortCode resource being added to the Service.

Example
        
        
        
        

        Fetch a ShortCode resource

        get
        https://messaging.twilio.com/v1/Services/{ServiceSid}/ShortCodes/{Sid}
        Parameters
        Names in None format
        service_sid
        Required
        get sid<MG> Not PII

        The SID of the Service to fetch the resource from.

        sid
        Required
        get sid_like<SC> Not PII

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

        Example
              
              
              
              

              Read multiple ShortCode resources

              get
              https://messaging.twilio.com/v1/Services/{ServiceSid}/ShortCodes
              Parameters
              Names in None format
              service_sid
              Required
              get sid<MG> Not PII

              The SID of the Service to read the resource from.

              Example
                    
                    
                    
                    

                    Delete a ShortCode resource

                    delete
                    https://messaging.twilio.com/v1/Services/{ServiceSid}/ShortCodes/{Sid}

                    Removing a short code from the Messaging Service does not release the short code from your account. You must cancel the short code from your Account in order to disassociate and delete the short code from your Messaging Service.

                    Returns a 204 NO CONTENT if the short code was successfully removed from the service.

                    Parameters
                    Names in None format
                    service_sid
                    Required
                    delete sid<MG> Not PII

                    The SID of the Service to delete the resource from.

                    sid
                    Required
                    delete sid_like<SC> Not PII

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

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