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?

Short Code

With Twilio Proxy, you associate phone numbers and short codes (this resource) directly with a Proxy Service. All added numbers go into the Proxy Number Pool associated with a given Proxy Service. For more information on managing the phone numbers in your number pool, refer to our Phone Number Management guide.

Note on Short Codes associated with Services

A Twilio short code associated with a Proxy Service cannot be associated with other Proxy Services in the same account.

ShortCode properties

Resource Properties in REST API format
sid
sid<SC> Not PII

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

account_sid
sid<AC> Not PII

The SID of the Account that created the ShortCode resource.

service_sid
sid<KS> Not PII

The SID of the ShortCode resource's parent Service resource.

date_created
date_time<iso8601> Not PII

The ISO 8601 date and time in GMT when the resource was created.

date_updated
date_time<iso8601> Not PII

The ISO 8601 date and time in GMT when the resource was last updated.

short_code
string Not PII

The short code's number.

iso_country
string Not PII

The ISO Country Code for the short code.

capabilities
phone_number_capabilities Not PII

The capabilities of the short code.

url
url Not PII

The absolute URL of the ShortCode resource.

is_reserved
boolean Not PII

Whether the short code should be reserved and not be assigned to a participant using proxy pool logic. See Reserved Phone Numbers for more information.

Add a Short Code to a Proxy Service

post
https://proxy.twilio.com/v1/Services/{ServiceSid}/ShortCodes
Parameters
Parameters in REST API format
service_sid
Path
post sid<KS> Not PII

The SID of the parent Service resource.

sid
Required
post sid<SC> Not PII

The SID of a Twilio ShortCode resource that represents the short code you would like to assign to your Proxy Service.

Example 1
        
        
        
        

        Fetch a ShortCode resource

        get
        https://proxy.twilio.com/v1/Services/{ServiceSid}/ShortCodes/{Sid}
        Parameters
        Parameters in REST API format
        service_sid
        Path
        get sid<KS> Not PII

        The SID of the parent Service to fetch the resource from.

        sid
        Path
        get sid<SC> Not PII

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

        Example 1
              
              
              
              

              Get the list of Short Codes associated with a Proxy Service

              get
              https://proxy.twilio.com/v1/Services/{ServiceSid}/ShortCodes
              Parameters
              Parameters in REST API format
              service_sid
              Path
              get sid<KS> Not PII

              The SID of the parent Service to read the resources from.

              Example 1
                    
                    
                    
                    

                    Update a ShortCode resource

                    post
                    https://proxy.twilio.com/v1/Services/{ServiceSid}/ShortCodes/{Sid}
                    Parameters
                    Parameters in REST API format
                    service_sid
                    Path
                    post sid<KS> Not PII

                    The SID of the parent Service of the resource to update.

                    sid
                    Path
                    post sid<SC> Not PII

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

                    is_reserved
                    Optional
                    post boolean Not PII

                    Whether the short code should be reserved and not be assigned to a participant using proxy pool logic. See Reserved Phone Numbers for more information.

                    Example 1
                          
                          
                          
                          

                          Remove a Short Code from a Proxy Service

                          delete
                          https://proxy.twilio.com/v1/Services/{ServiceSid}/ShortCodes/{Sid}
                          Parameters
                          Parameters in REST API format
                          service_sid
                          Path
                          delete sid<KS> Not PII

                          The SID of the parent Service resource to delete the ShortCode resource from.

                          sid
                          Path
                          delete sid<SC> Not PII

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

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