Fetch a specific Phone Number.

GET /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}

Fetch a specific Phone Number.

Path parameters

  • ServiceSid string Required

    The SID of the parent Service of the PhoneNumber resource to fetch.

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

  • Sid string Required

    The Twilio-provided string that uniquely identifies the PhoneNumber resource to fetch.

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

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

    • account_sid string | null

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

    • 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.

    • phone_number string(phone-number) | null

      The phone number in E.164 format, which consists of a + followed by the country code and subscriber number.

    • friendly_name string | null

      The string that you assigned to describe the resource.

    • iso_country string | null

      The ISO Country Code for the phone number.

    • capabilities object(phone-number-capabilities) | null

      The capabilities of the phone number.

      Hide capabilities attributes Show capabilities attributes object(phone-number-capabilities) | null
      • fax boolean
      • mms boolean
      • sms boolean
      • voice boolean
    • url string(uri) | null

      The absolute URL of the PhoneNumber resource.

    • is_reserved boolean | null

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

    • in_use integer

      The number of open session assigned to the number. See the How many Phone Numbers do I need? guide for more information.

      Default value is 0.

GET /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}
curl \
 --request GET 'https://proxy.twilio.com/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}' \
 --user "username:password"
Response examples (200)
{
  "sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "in_use": 0,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "is_reserved": false,
  "iso_country": "US",
  "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "capabilities": {
    "sms_outbound": true,
    "voice_inbound": false
  },
  "date_created": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "phone_number": "12345",
  "friendly_name": "Friendly Name"
}