Messaging Service ShortCode Resource
The ShortCode subresource of a Service Resource represents the short codes you have associated to the Service.
When a short code has been added to the Messaging Service, Twilio always prioritizes message delivery with your short code when possible. If the short code cannot be used to reach your user, Twilio performs a Short Code Reroute to sent the message from a long code in your Messaging Service instead.
Inbound messages received on any of short codes associated with a Messaging Service are passed to the inbound request URL of the Service with the TWiML parameters that describe the message.
Property nameTypePIIDescription
The unique string that we created to identify the ShortCode resource.
Pattern: ^SC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The SID of the Account that created the ShortCode resource.
Pattern: ^AC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The SID of the Service the resource is associated with.
Pattern: ^MG[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
date_createdstring<date-time>
date_updatedstring<date-time>
The E.164 format of the short code.
capabilitiesarray[string] An array of values that describe whether the number can receive calls or messages. Can be: SMS
and MMS
.
The absolute URL of the ShortCode resource.
POST https://messaging.twilio.com/v1/Services/{ServiceSid}/ShortCodes
Property nameTypeRequiredPIIDescription
ServiceSidSID<MG>required The SID of the Service to create the resource under.
Pattern: ^MG[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
Property nameTypeRequiredPIIDescription
ShortCodeSidSID<SC>required The SID of the ShortCode resource being added to the Service.
Pattern: ^SC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18async function createShortCode() {
_18 const shortCode = await client.messaging.v1
_18 .services("MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18 .shortCodes.create({ shortCodeSid: "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" });
_18 console.log(shortCode.sid);
_13 "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_13 "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_13 "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_13 "date_created": "2015-07-30T20:12:31Z",
_13 "date_updated": "2015-07-30T20:12:33Z",
_13 "short_code": "12345",
_13 "country_code": "US",
_13 "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
GET https://messaging.twilio.com/v1/Services/{ServiceSid}/ShortCodes/{Sid}
Property nameTypeRequiredPIIDescription
ServiceSidSID<MG>required The SID of the Service to fetch the resource from.
Pattern: ^MG[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The SID of the ShortCode resource to fetch.
_19// Download the helper library from https://www.twilio.com/docs/node/install
_19const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19// Find your Account SID and Auth Token at twilio.com/console
_19// and set the environment variables. See http://twil.io/secure
_19const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19const authToken = process.env.TWILIO_AUTH_TOKEN;
_19const client = twilio(accountSid, authToken);
_19async function fetchShortCode() {
_19 const shortCode = await client.messaging.v1
_19 .services("MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19 console.log(shortCode.sid);
_13 "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_13 "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_13 "date_created": "2015-07-30T20:12:31Z",
_13 "date_updated": "2015-07-30T20:12:33Z",
_13 "short_code": "12345",
_13 "country_code": "US",
_13 "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
GET https://messaging.twilio.com/v1/Services/{ServiceSid}/ShortCodes
Property nameTypeRequiredPIIDescription
ServiceSidSID<MG>required The SID of the Service to read the resources from.
Pattern: ^MG[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
Property nameTypeRequiredPIIDescription
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Minimum: 1
Maximum: 1000
The page index. This value is simply for client state.
Minimum: 0
The page token. This is provided by the API.
_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18async function listShortCode() {
_18 const shortCodes = await client.messaging.v1
_18 .services("MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18 .shortCodes.list({ limit: 20 });
_18 shortCodes.forEach((s) => console.log(s.sid));
_26 "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=20&Page=0",
_26 "previous_page_url": null,
_26 "next_page_url": null,
_26 "key": "short_codes",
_26 "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=20&Page=0"
_26 "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_26 "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_26 "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_26 "date_created": "2015-07-30T20:12:31Z",
_26 "date_updated": "2015-07-30T20:12:33Z",
_26 "short_code": "12345",
_26 "country_code": "US",
_26 "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
DELETE https://messaging.twilio.com/v1/Services/{ServiceSid}/ShortCodes/{Sid}
Warning
Removing a short code from the Messaging Service does not release the short code from your account. You must cancel the short code from your Account in order to disassociate and delete the short code from your Messaging Service.
Returns a 204 NO CONTENT
if the short code was successfully removed from the service.
Property nameTypeRequiredPIIDescription
ServiceSidSID<MG>required The SID of the Service to delete the resource from.
Pattern: ^MG[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The SID of the ShortCode resource to delete.
_17// Download the helper library from https://www.twilio.com/docs/node/install
_17const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_17// Find your Account SID and Auth Token at twilio.com/console
_17// and set the environment variables. See http://twil.io/secure
_17const accountSid = process.env.TWILIO_ACCOUNT_SID;
_17const authToken = process.env.TWILIO_AUTH_TOKEN;
_17const client = twilio(accountSid, authToken);
_17async function deleteShortCode() {
_17 await client.messaging.v1
_17 .services("MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")