Path parameters

• ServiceSid string Required

  The SID of the parent Service of the PhoneNumber resources to read.

Query parameters

• PageSize integer

  How many resources to return in each list page. The default is 50, and the maximum is 1000.

  Minimum value is 1, maximum value is 1000.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri)
    • page integer
    • page_size integer
    • previous_page_url string(uri)
    • url string(uri)
  • phone_numbers array[object]
    Hide phone_numbers attributes Show phone_numbers attributes array[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

      • fax boolean
      • mms boolean
      • sms boolean
      • voice boolean
    • 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