AlphaSender Resource
Public Beta
The Service Resource is currently available as a Public Beta product. This means that some features for configuring your Messaging Service via the REST API are not yet implemented, and others may be changed before the product is declared Generally Available. Messaging Service Configuration through the Twilio Console is Generally Available.
Public Beta products are not covered by a Twilio SLA.
The resources for sending Messages with a Messaging Service are Generally Available.
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, Twilio Programmable Messaging 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.
Please see this support article for more information on how to use Alphanumeric Sender ID with Messaging Services.
AlphaSender properties
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string that we created to identify the AlphaSender resource. |
account_sid
|
The SID of the Account that created the AlphaSender resource. |
service_sid
|
The SID of the Service the resource is associated with. |
date_created
|
The date and time in GMT when the resource was created specified in ISO 8601 format. |
date_updated
|
The date and time in GMT when the resource was last updated specified in ISO 8601 format. |
alpha_sender
|
The Alphanumeric Sender ID string. |
capabilities
|
An array of values that describe whether the number can receive calls or messages. Can be: |
url
|
The absolute URL of the AlphaSender resource. |
Create an AlphaSender resource
https://messaging.twilio.com/v1/Services/{ServiceSid}/AlphaSenders
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to create the resource under. |
alpha_sender
Required
|
The Alphanumeric Sender ID string. Can be up to 11 characters long. Valid characters are A-Z, a-z, 0-9, space, hyphen |
Example 1
Fetch an AlphaSender resource
https://messaging.twilio.com/v1/Services/{ServiceSid}/AlphaSenders/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to fetch the resource from. |
sid
Path
|
The SID of the AlphaSender resource to fetch. |
Example 1
Read multiple AlphaSender resources
https://messaging.twilio.com/v1/Services/{ServiceSid}/AlphaSenders
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to read the resources from. |
Example 1
Delete an AlphaSender resource
https://messaging.twilio.com/v1/Services/{ServiceSid}/AlphaSenders/{Sid}
Returns "204 NO CONTENT" if the alpha sender was successfully removed from the Service.
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to delete the resource from. |
sid
Path
|
The SID of the AlphaSender resource to delete. |
Example 1
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 by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
