Phone numbers
GET/v1/numbers
Numbers the key owner can call from ("Call from")
Parameters
| Name | Type | Description |
|---|---|---|
limit | query · integer |
Response 200
| Name | Type | Description |
|---|---|---|
data required | object[] | |
data[].id required | string | Number id: send it as from in POST /v1/calls |
data[].e164 required | string | |
data[].label required | string | null | |
data[].status required | "active" | Only numbers that can call right now are listed |
data[].shared required | boolean | true = the Kanutus shared number (not your organization's own) |
data[].default required | boolean | The number used when from is not sent |
Example
curl
curl "https://api.kanutus.com/v1/numbers" \
-H "Authorization: Bearer $KANUTUS_API_KEY"Node.js
const res = await fetch("https://api.kanutus.com/v1/numbers", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.KANUTUS_API_KEY}`,
},
});
console.log(res.status, await res.json());Python
import os, uuid, requests
r = requests.request(
"GET",
"https://api.kanutus.com/v1/numbers",
headers={"Authorization": f"Bearer {os.environ['KANUTUS_API_KEY']}"},
)
print(r.status_code, r.json())Try it
Runs from your browser against the real API. Use a kt_test_ key: nothing is charged. The key stays in this tab only.
GET /v1/numbersResponses by status
200 Numbers: the organization's own first, the shared one last
200
{
"data": [
{
"id": "9b2f6c1e-4d0a-4f55-8a43-2f1d6c7e0a11",
"e164": "+16465551234",
"label": "Sales",
"status": "active",
"shared": true,
"default": true
}
]
}400 Invalid request
400 application/problem+json
{
"type": "https://docs.kanutus.com/errors",
"title": "<code>",
"status": 400,
"code": "<code>",
"message": "…",
"request_id": "req_…"
}401 Missing, invalid, expired or revoked credential
401 application/problem+json
{
"type": "https://docs.kanutus.com/errors",
"title": "<code>",
"status": 401,
"code": "<code>",
"message": "…",
"request_id": "req_…"
}403 Missing permission, blocked or not allowed
403 application/problem+json
{
"type": "https://docs.kanutus.com/errors",
"title": "<code>",
"status": 403,
"code": "<code>",
"message": "…",
"request_id": "req_…"
}429 Rate limit exceeded (see RateLimit-* and Retry-After headers)
429 application/problem+json
{
"type": "https://docs.kanutus.com/errors",
"title": "<code>",
"status": 429,
"code": "<code>",
"message": "…",
"request_id": "req_…"
}