Skip to content Skip to navigation Skip to topbar

Twilio Docs

Programmable Messaging

Getting Started

Messaging Onboarding Guides

Overview 1. SMS Foundations 2. Prepare your sender strategy 3. Build your Account 4. Monitor your application

How to work with your Twilio Free Trial account (US only)How to work with your Twilio Free Trial account (rest of world)Guide to using the Twilio Virtual Phone Messaging Services Quickstart SMS Quickstarts WhatsApp Quickstarts

API Reference

Message Resource

Overview MessageFeedback Resource Media Resource

Service Resource

Service Resource AlphaSender Resource ChannelSender Resource PhoneNumber Resource ShortCode Resource (A2P 10DLC) BrandRegistration Resource (A2P 10DLC) BrandVetting Resource (A2P 10DLC) UsAppToPerson Resource (A2P 10DLC) UsAppToPersonUsecase Resource

Messaging: Country Pricing Resource Deactivations Resource ShortCode Resource

Preventing Fraud

Preventing Fraud in Programmable Messaging SMS Pumping Protection

Tutorials

Receive and Reply to Incoming Messages Send SMS and MMS Messages Send Appointment Reminders Retrieve and Modify Message History Browse all Messaging tutorials

Messaging Services

Overview Send Messages with Messaging Services Manage opt-ins and opt-outs Best Practices for Scaling with Messaging Services Manage queueing and latency Alphanumeric Sender IDs

Messaging Features

SMS Pumping Protection

Messaging Insights

Overview Dashboards Messaging Intelligence

Message Scheduling Link Shortening

Usage Guides

How to work with your Twilio Free Trial account (US only)How to work with your Twilio Free Trial account (rest of world)Guide to using the Twilio Virtual Phone Preventing Fraud in Programmable Messaging What to Know Before Sending International SMS Messages SMS Geo Permissions Twilio's request to your incoming message Webhook URL Outbound Message Status in Status Callbacks Track the Message Status of Outbound Messages Best Practices for Messaging Delivery Status Logging Safeguard with Message redaction Debugging Common Issues with SMS How to Optimize Message Deliverability with Message Feedback

TwiML

Overview <Message><Redirect>

US A2P 10DLC

US A2P 10DLC Overview Required Business Information Registration for Government and Non-Profit Agencies

Register Your Business

Direct Standard and Low Volume Standard Registration Direct Sole Proprietor Registration Transition from a Sole Proprietor Brand to a Standard Brand

For ISVs: Register Your Customers

ISV Onboarding Overview Standard and Low-Volume Standard Registration Sole Proprietor Registration Use Externally Registered Campaigns Create Mock Brands and Campaigns

Troubleshooting A2P 10DLC Registrations Set Up Notifications for A2P 10DLC

Toll-Free Verification

Console Onboarding Guide REST API Onboarding Guide

Messaging Channels

Overview WhatsApp Facebook Messenger (Public Beta)Google Business Messages (Public Beta)

Other Messaging products

Content Editor: message templates for any messaging channel Conversations: two-way messaging Verify: user verification and one-time passwords

Related docs

Phone Numbers General Usage Identity and Access Management (IAM)

Messaging
Voice
Serverless
Flex
Studio
All docs...

SDKs
Help

Log in
Sign up

Rate this page:

12345

On this page

AlphaSender Properties
Create an AlphaSender resource

Path parameters
Request body parameters
Fetch an AlphaSender resource
Path parameters
Read multiple AlphaSender resources
Path parameters
Query parameters
Delete an AlphaSender resource
Path parameters

AlphaSender Properties

Create an AlphaSender resource

Path parameters

Request body parameters

Fetch an AlphaSender resource

Path parameters

Read multiple AlphaSender resources

Path parameters

Query parameters

Delete an AlphaSender resource

Path parameters

Messaging Service AlphaSender Resource

(warning)

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.

(warning)

Warning

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.

(information)

Info

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

(information)

Info

Please see this support article for more information on how to use Alphanumeric Sender ID with Messaging Services.

AlphaSender Properties

Property nameTypePIIDescription

sidSID<AI>

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

Pattern: ^AI[0-9a-fA-F]{32}$Min length: 34Max length: 34

account_sidSID<AC>

The SID of the Account that created the AlphaSender resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

service_sidSID<MG>

The SID of the Service the resource is associated with.

Pattern: ^MG[0-9a-fA-F]{32}$Min length: 34Max length: 34

date_createdstring<date-time>

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

date_updatedstring<date-time>

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

alpha_senderstring

The Alphanumeric Sender ID string.

capabilitiesarray[string]

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

urlstring<uri>

The absolute URL of the AlphaSender resource.

Create an AlphaSender resource

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

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidSID<MG>required

The SID of the Service to create the resource under.

Pattern: ^MG[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Property nameTypeRequiredPIIDescription

AlphaSenderstringrequired

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

Create: an Alpha Sender

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11
_11client.messaging.v1.services('MG2172dd2db502e20dd981ef0d67850e1a')
_11                   .alphaSenders
_11                   .create({alphaSender: 'My company'})
_11                   .then(alpha_sender => console.log(alpha_sender.sid));

Output


_12{
_12  "sid": "AIXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12  "service_sid": "MG2172dd2db502e20dd981ef0d67850e1a",
_12  "date_created": "2015-07-30T20:12:31Z",
_12  "date_updated": "2015-07-30T20:12:33Z",
_12  "alpha_sender": "My company",
_12  "capabilities": [
_12    "SMS"
_12  ],
_12  "url": "https://messaging.twilio.com/v1/Services/MG2172dd2db502e20dd981ef0d67850e1a/AlphaSenders/AIXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_12}

Fetch an AlphaSender resource

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

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidSID<MG>required

The SID of the Service to fetch the resource from.

Pattern: ^MG[0-9a-fA-F]{32}$Min length: 34Max length: 34

Sidstringrequired

The SID of the AlphaSender resource to fetch.

Fetch an Alpha Sender

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11
_11client.messaging.v1.services('MG2172dd2db502e20dd981ef0d67850e1a')
_11                   .alphaSenders('AIc781610ec0b3400c9e0cab8e757da937')
_11                   .fetch()
_11                   .then(alpha_sender => console.log(alpha_sender.sid));

Output


_12{
_12  "sid": "AIc781610ec0b3400c9e0cab8e757da937",
_12  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12  "service_sid": "MG2172dd2db502e20dd981ef0d67850e1a",
_12  "date_created": "2015-07-30T20:12:31Z",
_12  "date_updated": "2015-07-30T20:12:33Z",
_12  "alpha_sender": "Twilio",
_12  "capabilities": [
_12    "SMS"
_12  ],
_12  "url": "https://messaging.twilio.com/v1/Services/MG2172dd2db502e20dd981ef0d67850e1a/AlphaSenders/AIXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_12}

Read multiple AlphaSender resources

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

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidSID<MG>required

The SID of the Service to read the resources from.

Pattern: ^MG[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeintegerOptional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

The page token. This is provided by the API.

Read Alpha Senders

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11
_11client.messaging.v1.services('MG2172dd2db502e20dd981ef0d67850e1a')
_11      .alphaSenders
_11      .list({limit: 20})
_11      .then(alphaSenders => alphaSenders.forEach(a => console.log(a.sid)));

Output


_25{
_25  "meta": {
_25    "page": 0,
_25    "page_size": 20,
_25    "first_page_url": "https://messaging.twilio.com/v1/Services/MG2172dd2db502e20dd981ef0d67850e1a/AlphaSenders?PageSize=20&Page=0",
_25    "previous_page_url": "https://messaging.twilio.com/v1/Services/MG2172dd2db502e20dd981ef0d67850e1a/AlphaSenders?PageSize=20&Page=0",
_25    "next_page_url": "https://messaging.twilio.com/v1/Services/MG2172dd2db502e20dd981ef0d67850e1a/AlphaSenders?PageSize=20&Page=1",
_25    "key": "alpha_senders",
_25    "url": "https://messaging.twilio.com/v1/Services/MG2172dd2db502e20dd981ef0d67850e1a/AlphaSenders?PageSize=20&Page=0"
_25  },
_25  "alpha_senders": [
_25    {
_25      "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25      "service_sid": "MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25      "sid": "AIXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25      "date_created": "2015-07-30T20:12:31Z",
_25      "date_updated": "2015-07-30T20:12:33Z",
_25      "alpha_sender": "Twilio",
_25      "capabilities": [
_25        "SMS"
_25      ],
_25      "url": "https://messaging.twilio.com/v1/Services/MG2172dd2db502e20dd981ef0d67850e1a/AlphaSenders/AIXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_25    }
_25  ]
_25}

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.

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidSID<MG>required

The SID of the Service to delete the resource from.

Pattern: ^MG[0-9a-fA-F]{32}$Min length: 34Max length: 34

Sidstringrequired

The SID of the AlphaSender resource to delete.

Delete: Remove a Alpha Sender from a Service

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_10// Download the helper library from https://www.twilio.com/docs/node/install
_10// Find your Account SID and Auth Token at twilio.com/console
_10// and set the environment variables. See http://twil.io/secure
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10
_10client.messaging.v1.services('MG2172dd2db502e20dd981ef0d67850e1a')
_10                   .alphaSenders('AIc781610ec0b3400c9e0cab8e757da937')
_10                   .remove();

Rate this page:

12345

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.

Terms of service

Copyright © 2024 Twilio Inc.