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?

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

Names in PHP format
sid
sid<SC> Not PII

A 34 character string that uniquely identifies this Short Code.

accountSid
sid<AC> Not PII

The unique SID identifier of the Account.

serviceSid
sid<KS> Not PII

The unique SID identifier of the Service.

dateCreated
date_time<iso8601> Not PII

The date that this Short Code was added to the service, given in ISO 8601 format.

dateUpdated
date_time<iso8601> Not PII

The date that this Short Code was updated, given in ISO 8601 format.

shortCode
string Not PII

The Shortcode's number.

isoCountry
string Not PII

The ISO Country Code for this shortcode.

capabilities
phone_number_capabilities Not PII

A list of capabilities of this short code.

url
url Not PII

The URL of this resource.

isReserved
boolean Not PII

Whether or not the short code should be excluded from being assigned to a participant using proxy pool logic

Add a Short Code to a Proxy Service

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

The unique SID identifier of the Service.

sid
Required
post sid<SC> Not PII

A 34 character string that uniquely identifies this Short Code.

Example
        
        
        
        

        Fetch a ShortCode resource

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

        The unique SID identifier of the Service.

        sid
        Required
        get sid<SC> Not PII

        A 34 character string that uniquely identifies this Short Code.

        Example
              
              
              
              

              Get the list of Short Codes associated with a Proxy Service

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

              The unique SID identifier of the Service.

              Example
                    
                    
                    
                    

                    Update a ShortCode resource

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

                    The unique SID identifier of the Service.

                    sid
                    Required
                    post sid<SC> Not PII

                    A 34 character string that uniquely identifies this Short Code.

                    is_reserved
                    Optional
                    post boolean Not PII

                    Whether or not the short code should be excluded from being assigned to a participant using proxy pool logic

                    Example
                          
                          
                          
                          

                          Remove a Short Code from a Proxy Service

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

                          The unique SID identifier of the Service.

                          sid
                          Required
                          delete sid<SC> Not PII

                          A 34 character string that uniquely identifies this Short Code.

                          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.