Phone numbers

Base URL https://api.zoe-tel.com. Desired routing is the configuration you set. Applied routing is what the switch is currently doing.

Reads

Method	Path	Who
GET	/v1/numbers	Session, or a key with the numbers scope
GET	/v1/numbers/inventory	Session, or a key with the numbers scope
GET	/v1/numbers/{id}/usage?from&to	Session, or a key with the numbers scope
GET	/v1/numbers/live?ids=	Signed-in member. Not an API key. Up to 200 ids.
GET	/v1/numbers/{id}/routing	Owner, admin, or developer, or a key with the numbers scope

from and to on usage are required ISO-8601 UTC timestamps ending in Z.

GET /v1/numbers/inventory does not return stock. The carrier inventory API is not connected.

PUT /v1/numbers/{id}/routing

Owner, admin, or developer, or a key with numbers_write or full. Requires Idempotency-Key.

A key may set sip_uri, connection, or unrouted. forward and webhook are member sessions only.

Reservations

Method	Path	Who
POST	/v1/numbers/reservations	Owner, admin, or developer
DELETE	/v1/numbers/reservations/{id}	Owner, admin, or developer

These two do not take Idempotency-Key. They sit on the same absent carrier inventory as GET /v1/numbers/inventory. An API key cannot call them.

Orders and release

Method	Path	Who
POST	/v1/numbers/orders	Owner or admin. Idempotency-Key required.
GET	/v1/numbers/orders/{id}	Signed-in member
POST	/v1/numbers/{id}/release	Owner or admin. Idempotency-Key required.

An API key cannot order or release. The order runs as a job. GET /v1/jobs/{job_id} is readable by a key.