v1

latestOpenAPI 3.0.12026-07-266184114.0 KB
Numbers

List phone numbers

List your purchased/assigned phone numbers. For corporate members all assigned numbers will be returned, while for the corporate admin, all purchased numbers. (Permitted scopes: fax:all:read, fax:numbers:read)

get/accounts/{user_id}/numbers

Path parameters

user_idstring required

ID of the user to get numbers for. Use 'self' for your own account, or provide a specific user ID for corporate member accounts.

Response

Response containing a list of number objects

Example response

{
  "numbers": [
    {
      "acquired_date": "2017-07-31 09:20:06",
      "assigned_to": [
        "7724157c0974440293e45877c57f0703"
      ],
      "expiration_date": null,
      "id": "e6e68ef87f0b8768ebacdb218994bfe7",
      "is_canceled": false,
      "notifications": [
        {
          "email": true,
          "push_notification": true,
          "type": "voicemail"
        },
        {
          "email": true,
          "push_notification": true,
          "type": "receive_fax"
        },
        {
          "email": true,
          "push_notification": true,
          "type": "announcement"
        },
        {
          "email": true,
          "push_notification": true,
          "type": "callforward"
        }
      ],
      "number": "+16699990000",
      "owner_id": "7724157c0974440293e45877c57f0703",
      "status": "active"
    }
  ]
}