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?

AlphaSender 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 AlphaSender is a subresource of a Service resource and represents an Alphanumeric Sender ID (alpha sender) you have associated with the Service.

When an alpha sender has been added to the Messaging Service, Copilot will always attempt to prioritize message delivery with your Alpha Sender where possible.

Each Messaging Services may only have one alpha sender associated with it. To change the Alpha Sender ID, you must first delete the current alpha sender before adding the new one.

This subresource is only available to Accounts in which the Alphanumeric Sender ID is enabled.

AlphaSender properties

Names in REST API format
sid
sid<AI> Not PII

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

account_sid
sid<AC> Not PII

The SID of the Account that created the AlphaSender resource.

service_sid
sid<MG> Not PII

The SID of the Service the resource is associated with.

date_created
date_time<iso8601> Not PII

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

date_updated
date_time<iso8601> Not PII

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

alpha_sender
string Not PII

The Alphanumeric Sender ID string.

capabilities
object[] Not PII

An array of values that describe whether the number can receive calls or messages. Can be: SMS.

url
url Not PII

The absolute URL of the AlphaSender resource.

Create an AlphaSender resource

post
https://messaging.twilio.com/v1/Services/{ServiceSid}/AlphaSenders
Parameters
Names in REST API format
service_sid
Path
post sid<MG> Not PII

The SID of the Service to create the resource under.

alpha_sender
Required
post string Not PII

The Alphanumeric Sender ID string. Can be up to 11 characters long. Valid characters are A-Z, a-z, 0-9, space, and hyphen -. This value cannot contain only numbers.

Example 1
        
        
        
        

        Fetch an AlphaSender resource

        get
        https://messaging.twilio.com/v1/Services/{ServiceSid}/AlphaSenders/{Sid}
        Parameters
        Names in REST API format
        service_sid
        Path
        get sid<MG> Not PII

        The SID of the Service to fetch the resource from.

        sid
        Path
        get sid_like<AI> Not PII

        The SID of the AlphaSender resource to fetch.

        Example 1
              
              
              
              

              Read multiple AlphaSender resources

              get
              https://messaging.twilio.com/v1/Services/{ServiceSid}/AlphaSenders
              Parameters
              Names in REST API format
              service_sid
              Path
              get sid<MG> Not PII

              The SID of the Service to read the resources from.

              Example 1
                    
                    
                    
                    

                    Delete an AlphaSender resource

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

                    Returns "204 NO CONTENT" if the alpha sender was successfully removed from the Service.

                    Parameters
                    Names in REST API format
                    service_sid
                    Path
                    delete sid<MG> Not PII

                    The SID of the Service to delete the resource from.

                    sid
                    Path
                    delete sid_like<AI> Not PII

                    The SID of the AlphaSender 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.