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

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

  • 201

    Created

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

      The SID of the Account that created the resource

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

    • capabilities array[string] | null

      An array of values that describe whether the number can receive calls or messages

    • country_code string | null

      The 2-character ISO Country Code of the number

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • service_sid string | null

      The SID of the Service that 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}$.

    • short_code string | null

      The E.164 format of the short code

    • sid string | null

      The unique string that identifies the resource

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

    • url string(uri) | null

      The absolute URL of the ShortCode resource
POST /v1/Services/{ServiceSid}/ShortCodes 
curl \
 -X POST https://messaging.twilio.com/v1/Services/{ServiceSid}/ShortCodes \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'ShortCodeSid=string'
Request example 
{
  "ShortCodeSid": "string"
}
Request examples 
{
  "ShortCodeSid": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "capabilities": [
    "string"
  ],
  "country_code": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "service_sid": "string",
  "short_code": "string",
  "sid": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "capabilities": [
    "string"
  ],
  "country_code": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "service_sid": "string",
  "short_code": "string",
  "sid": "string",
  "url": "https://example.com"
}