ShortCodes resource
A short code is a 5 or 6-digit number that can send and receive messages with mobile phones. These high-throughput numbers are perfect for apps that need to send messages to lots of users or need to send time-sensitive messages. You can buy short codes from Twilio or port existing short codes to Twilio.
To send messages from your short code, see the Sending Messages documentation.
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes/{Sid}.json
The SID of the Account that created the ShortCode resource(s) to fetch.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The Twilio-provided string that uniquely identifies the ShortCode resource to fetch
^SC[0-9a-fA-F]{32}$Min length: 34Max length: 341// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function fetchShortCode() {11const shortCode = await client12.shortCodes("SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")13.fetch();1415console.log(shortCode.accountSid);16}1718fetchShortCode();
Response
1{2"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"api_version": "2010-04-01",4"date_created": "Thu, 01 Apr 2010 00:00:00 +0000",5"date_updated": "Thu, 01 Apr 2010 00:00:00 +0000",6"friendly_name": "API_CLUSTER_TEST_SHORT_CODE",7"short_code": "99990",8"sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",9"sms_fallback_method": "POST",10"sms_fallback_url": null,11"sms_method": "POST",12"sms_url": null,13"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"14}
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes.json
Returns a list of ShortCodes, each representing a short code within your account. This list includes paging information.
The following query string parameters allow you to limit the list returned.
Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit.
How many resources to return in each list page. The default is 50, and the maximum is 1000.
1Maximum: 1000The page token. This is provided by the API.
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function listShortCode() {11const shortCodes = await client.shortCodes.list({ limit: 20 });1213shortCodes.forEach((s) => console.log(s.end));14}1516listShortCode();
Response
1{2"end": 0,3"first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?FriendlyName=friendly_name&ShortCode=short_code&PageSize=50&Page=0",4"next_page_uri": null,5"page": 0,6"page_size": 50,7"previous_page_uri": null,8"short_codes": [9{10"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",11"api_version": "2010-04-01",12"date_created": "Thu, 01 Apr 2010 00:00:00 +0000",13"date_updated": "Thu, 01 Apr 2010 00:00:00 +0000",14"friendly_name": "API_CLUSTER_TEST_SHORT_CODE",15"short_code": "99990",16"sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",17"sms_fallback_method": "POST",18"sms_fallback_url": null,19"sms_method": "POST",20"sms_url": null,21"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"22}23],24"start": 0,25"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?FriendlyName=friendly_name&ShortCode=short_code&PageSize=50&Page=0"26}
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function listShortCode() {11const shortCodes = await client.shortCodes.list({12shortCode: "67898",13limit: 20,14});1516shortCodes.forEach((s) => console.log(s.end));17}1819listShortCode();
Response
1{2"end": 0,3"first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?FriendlyName=friendly_name&ShortCode=short_code&PageSize=50&Page=0",4"next_page_uri": null,5"page": 0,6"page_size": 50,7"previous_page_uri": null,8"short_codes": [9{10"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",11"api_version": "2010-04-01",12"date_created": "Thu, 01 Apr 2010 00:00:00 +0000",13"date_updated": "Thu, 01 Apr 2010 00:00:00 +0000",14"friendly_name": "API_CLUSTER_TEST_SHORT_CODE",15"short_code": "99990",16"sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",17"sms_fallback_method": "POST",18"sms_fallback_url": null,19"sms_method": "POST",20"sms_url": null,21"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"22}23],24"start": 0,25"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?FriendlyName=friendly_name&ShortCode=short_code&PageSize=50&Page=0"26}
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function listShortCode() {11const shortCodes = await client.shortCodes.list({12shortCode: "898",13limit: 20,14});1516shortCodes.forEach((s) => console.log(s.end));17}1819listShortCode();
Response
1{2"end": 0,3"first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?FriendlyName=friendly_name&ShortCode=short_code&PageSize=50&Page=0",4"next_page_uri": null,5"page": 0,6"page_size": 50,7"previous_page_uri": null,8"short_codes": [9{10"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",11"api_version": "2010-04-01",12"date_created": "Thu, 01 Apr 2010 00:00:00 +0000",13"date_updated": "Thu, 01 Apr 2010 00:00:00 +0000",14"friendly_name": "API_CLUSTER_TEST_SHORT_CODE",15"short_code": "99990",16"sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",17"sms_fallback_method": "POST",18"sms_fallback_url": null,19"sms_method": "POST",20"sms_url": null,21"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"22}23],24"start": 0,25"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes.json?FriendlyName=friendly_name&ShortCode=short_code&PageSize=50&Page=0"26}
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes/{Sid}.json
Tries to update the short code's properties. This API call returns the updated resource representation if it is successful. The returned response is identical to that returned when making a GET request.
The SID of the Account that created the ShortCode resource(s) to update.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The Twilio-provided string that uniquely identifies the ShortCode resource to update
^SC[0-9a-fA-F]{32}$Min length: 34Max length: 34application/x-www-form-urlencodedA descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the FriendlyName is the short code.
The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01.
The URL we should call when receiving an incoming SMS message to this short code.
The HTTP method we should use when calling the sms_url. Can be: GET or POST.
GETPOSTThe URL that we should call if an error occurs while retrieving or executing the TwiML from sms_url.
The HTTP method that we should use to call the sms_fallback_url. Can be: GET or POST.
GETPOST1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function updateShortCode() {11const shortCode = await client12.shortCodes("SC6b20cb705c1e8f00210049b20b70fce3")13.update({ smsUrl: "http://demo.twilio.com/docs/sms.xml" });1415console.log(shortCode.accountSid);16}1718updateShortCode();
Response
1{2"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",3"api_version": "2010-04-01",4"date_created": "Thu, 01 Apr 2010 00:00:00 +0000",5"date_updated": "Thu, 01 Apr 2010 00:00:00 +0000",6"friendly_name": "API_CLUSTER_TEST_SHORT_CODE",7"short_code": "99990",8"sid": "SC6b20cb705c1e8f00210049b20b70fce3",9"sms_fallback_method": "POST",10"sms_fallback_url": null,11"sms_method": "POST",12"sms_url": "http://demo.twilio.com/docs/sms.xml",13"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SMS/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"14}