Add a Phone Number to a Service's Proxy Number Pool

POST /v1/Services/{ServiceSid}/PhoneNumbers

TODO: Resource-level docs

Add a Phone Number to a Service's Proxy Number Pool.

Path parameters

Body

  • IsReserved boolean

    Whether the new phone number should be reserved and not be assigned to a participant using proxy pool logic. See Reserved Phone Numbers for more information.

  • PhoneNumber string(phone-number)

    The phone number in E.164 format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.

  • Sid string

    The SID of a Twilio IncomingPhoneNumber resource that represents the Twilio Number you would like to assign to your Proxy Service.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^PN[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 phone number

      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

    • friendly_name string | null

      The string that you assigned to describe the resource

    • in_use integer | null

      The number of open session assigned to the number.

    • is_reserved boolean | null

      Reserve the phone number for manual assignment to participants only

    • iso_country string | null

      The ISO Country Code

    • phone_number string(phone-number) | null

      The phone number in E.164 format

    • service_sid string | null

      The SID of the PhoneNumber resource's parent Service resource

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

    • sid string | null

      The unique string that identifies the resource

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

    • url string(uri) | null

      The absolute URL of the PhoneNumber resource
POST /v1/Services/{ServiceSid}/PhoneNumbers 
curl \
 -X POST https://proxy.twilio.com/v1/Services/{ServiceSid}/PhoneNumbers \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'IsReserved=true&PhoneNumber=string&Sid=string'
Request example 
{
  "IsReserved": true,
  "PhoneNumber": "string",
  "Sid": "string"
}
Request examples 
{
  "IsReserved": true,
  "PhoneNumber": "string",
  "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",
  "friendly_name": "string",
  "in_use": 42,
  "is_reserved": true,
  "iso_country": "string",
  "phone_number": "string",
  "service_sid": "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",
  "friendly_name": "string",
  "in_use": 42,
  "is_reserved": true,
  "iso_country": "string",
  "phone_number": "string",
  "service_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}