Short Code
With Twilio Proxy, you associate phone numbers and short codes (this resource) directly with a Proxy Service . All added numbers go into the Proxy Number Pool associated with a given Proxy Service. For more information on managing the phone numbers in your number pool, refer to our Phone Number Management guide .
Info A Twilio short code associated with a Proxy Service cannot be associated with other Proxy Services in the same account.
Resource properties The unique string that we created to identify the ShortCode resource.
date_created
type: string<DATE TIME> Not PIIdate_updated
type: string<DATE TIME> Not PIIThe ISO Country Code for the short code.
capabilities
type: object<PHONE NUMBER CAPABILITIES> Not PIIThe capabilities of the short code.
The absolute URL of the ShortCode resource.
POST https://proxy.twilio.com/v1/Services/{ServiceSid}/ShortCodes
URI parameters Request body parameters
_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
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.proxy.v1.services('KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .create({sid: 'SCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'})
_11 .then(short_code => console.log(short_code.sid));
_15 "sid": "SCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15 "service_sid": "KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15 "date_created": "2015-07-30T20:00:00Z",
_15 "date_updated": "2015-07-30T20:00:00Z",
_15 "short_code": "12345",
_15 "sms_outbound": true,
_15 "voice_inbound": false
_15 "url": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ShortCodes/SCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
GET https://proxy.twilio.com/v1/Services/{ServiceSid}/ShortCodes/{Sid}
URI parameters Path Parameter
The Twilio-provided string that uniquely identifies the ShortCode resource to fetch.
_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
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.proxy.v1.services('KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .shortCodes('SCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .then(short_code => console.log(short_code.sid));
_15 "sid": "SCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15 "service_sid": "KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15 "date_created": "2015-07-30T20:00:00Z",
_15 "date_updated": "2015-07-30T20:00:00Z",
_15 "short_code": "12345",
_15 "sms_outbound": true,
_15 "voice_inbound": false
_15 "url": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ShortCodes/SCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
GET https://proxy.twilio.com/v1/Services/{ServiceSid}/ShortCodes
URI parameters Query Parameter
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Query Parameter
The page index. This value is simply for client state.
Query Parameter
The page token. This is provided by the API.
_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
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.proxy.v1.services('KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .then(shortCodes => shortCodes.forEach(s => console.log(s.sid)));
_28 "first_page_url": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ShortCodes?PageSize=50&Page=0",
_28 "previous_page_url": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ShortCodes?PageSize=50&Page=0",
_28 "next_page_url": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ShortCodes?PageSize=50&Page=1",
_28 "key": "short_codes",
_28 "url": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ShortCodes?PageSize=50&Page=0"
_28 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_28 "service_sid": "KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_28 "sid": "SCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_28 "date_created": "2015-07-30T20:00:00Z",
_28 "date_updated": "2015-07-30T20:00:00Z",
_28 "short_code": "12345",
_28 "sms_outbound": true,
_28 "voice_inbound": false
_28 "url": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ShortCodes/SCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
POST https://proxy.twilio.com/v1/Services/{ServiceSid}/ShortCodes/{Sid}
URI parameters Path Parameter
The Twilio-provided string that uniquely identifies the ShortCode resource to update.
Request body parameters
_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
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.proxy.v1.services('KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .shortCodes('SCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .update({isReserved: true})
_11 .then(short_code => console.log(short_code.sid));
_15 "sid": "SCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15 "service_sid": "KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15 "date_created": "2015-07-30T20:00:00Z",
_15 "date_updated": "2015-07-30T20:00:00Z",
_15 "short_code": "12345",
_15 "sms_outbound": true,
_15 "voice_inbound": false
_15 "url": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ShortCodes/SCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
DELETE https://proxy.twilio.com/v1/Services/{ServiceSid}/ShortCodes/{Sid}
URI parameters Path Parameter
The Twilio-provided string that uniquely identifies the ShortCode resource to delete.
_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
_10 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10 const authToken = process.env.TWILIO_AUTH_TOKEN;
_10 const client = require('twilio')(accountSid, authToken);
_10 client.proxy.v1.services('KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10 .shortCodes('SCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')