Phone Numbers

Get a phone number by ID

Requires phone_numbers:r.

get/v1/phone-numbers/{id}

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/phone-numbers/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Response

The number, released ones included.

idstring required
phone_numberstring required

E.164

area_codestring required
regionstring nullable required

Province or territory, when the area code maps to one.

capabilitiesstring[] required
status'ACTIVE' | 'SUSPENDED' | 'RELEASING' | 'RELEASED' required
monthly_cost_centsinteger required

Recurring rent in CAD cents.

provisioned_atstring date-time required
released_atstring date-time nullable required
number_type'local' | 'toll_free' required

Toll-free numbers (833, 844, 855, 866, 877, 888) need an approved toll-free verification before they can send SMS.

Changes

No recorded changes to this operation across all 1 revision of this API.