Add a Short Code to the Proxy Number Pool for the Service

POST /v1/Services/{ServiceSid}/ShortCodes

TODO: Resource-level docs

Add a Short Code to the Proxy Number Pool for the Service.

Path parameters

Body

  • Sid string Required

    The SID of a Twilio ShortCode resource that represents the short code you would like to assign to your Proxy 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 object(phone-number-capabilities) | null

      The capabilities of the short code

      Hide capabilities attributes Show capabilities attributes object(phone-number-capabilities) | null
    • 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

    • is_reserved boolean | null

      Whether the short code should be reserved for manual assignment to participants only

    • iso_country string | null

      The ISO Country Code

    • service_sid string | null

      The SID of the resource's parent Service

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

    • short_code string | null

      The short code's number

    • 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://proxy.twilio.com/v1/Services/{ServiceSid}/ShortCodes \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Sid=string'
Request example 
{
  "Sid": "string"
}
Request examples 
{
  "Sid": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "capabilities": {
    "fax": true,
    "mms": true,
    "sms": true,
    "voice": true
  },
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "is_reserved": true,
  "iso_country": "string",
  "service_sid": "string",
  "short_code": "string",
  "sid": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "capabilities": {
    "fax": true,
    "mms": true,
    "sms": true,
    "voice": true
  },
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "is_reserved": true,
  "iso_country": "string",
  "service_sid": "string",
  "short_code": "string",
  "sid": "string",
  "url": "https://example.com"
}