Create short code

POST /v1/Services/{ServiceSid}/ShortCodes

A Messaging Service resource to add, fetch or remove short code numbers from a Messaging Service.

Path parameters

  • ServiceSid string Required

    The SID of the Service to create the resource under.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MG[0-9a-fA-F]{32}$.

application/x-www-form-urlencoded

Body

  • ShortCodeSid string Required

    The SID of the ShortCode resource being added to the Service.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^SC[0-9a-fA-F]{32}$.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^SC[0-9a-fA-F]{32}$.

    • account_sid string | null

      The SID of the Account that created the ShortCode resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • service_sid string | null

      The SID of the Service the resource is associated with.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MG[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • short_code string | null

      The E.164 format of the short code.

    • country_code string | null

      The 2-character ISO Country Code of the number.

    • capabilities array[string] | null

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

    • url string(uri) | null

      The absolute URL of the ShortCode resource.

  • 201 application/json

    Created

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^SC[0-9a-fA-F]{32}$.

    • account_sid string | null

      The SID of the Account that created the ShortCode resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • service_sid string | null

      The SID of the Service the resource is associated with.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MG[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • short_code string | null

      The E.164 format of the short code.

    • country_code string | null

      The 2-character ISO Country Code of the number.

    • capabilities array[string] | null

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

    • url string(uri) | null

      The absolute URL of the ShortCode resource.

POST /v1/Services/{ServiceSid}/ShortCodes
curl \
 --request POST 'https://messaging.twilio.com/v1/Services/{ServiceSid}/ShortCodes' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'ShortCodeSid=SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
{"ShortCodeSid"=>"SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}
{"ShortCodeSid"=>"SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}
Response examples (200)
{
  "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "short_code": "12345",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "capabilities": [
    "SMS"
  ],
  "country_code": "US",
  "date_created": "2015-07-30T20:12:31Z",
  "date_updated": "2015-07-30T20:12:33Z"
}
Response examples (201)
{
  "sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "short_code": "12345",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "capabilities": [
    "SMS"
  ],
  "country_code": "US",
  "date_created": "2015-07-30T20:12:31Z",
  "date_updated": "2015-07-30T20:12:33Z"
}