v1

latestOpenAPI 3.0.12026-07-266184114.0 KB

Numbers

Get number information

Get information about a single purchased/assigned fax number (Permitted scopes: fax:all:read, fax:numbers:read)

get/accounts/{user_id}/numbers/{number}

Path parameters

user_idstring required

ID of the number owner

numberstring required

Fax number to get information about

Response

Object containing number information

acquired_datestring required

Date and time at which the number was acquired

assigned_tostring[] required

IDs of the user to whom this number is assigned

expiration_datestring

Number expiration date, might be blank

idstring required

Number ID

is_canceledboolean

True if number is canceled but not yet deleted

numberstring required

Fax number

owner_idstring required

Number owner ID

status'waiting_verification' | 'active' required

Status of your fax number e.g. active, inactive.

Example response

{
  "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"
}