Numbers

Описания endpoints и полей показаны на английском языке, ровно так, как их публикует API. Это наш выбор: здесь вы читаете то же, что увидите в ответах.

POST /v1/numbers#

Claim a number. Claims a specific number, or any available number when the body is empty.

Тело запроса

application/json Схема: NumberClaimRequest

Ответы

Пример запроса

curl -X POST "https://api.voiceland.ai/v1/numbers" \
  -H "Authorization: Bearer VL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "e164": "+15550000001"
}'

Успешный ответ возвращает NumberClaimResponse.

Пример ответа

{
  "e164": "+15550000001",
  "status": "claimed"
}

GET /v1/numbers/available#

List available numbers. Numbers you can claim from the pool.

Параметры

Ответы

Пример запроса

curl "https://api.voiceland.ai/v1/numbers/available" \
  -H "Authorization: Bearer VL_API_KEY"

Пример ответа

{
  "items": [
    "+15550000001"
  ]
}

POST /v1/numbers/register#

Register an external number. Records an externally-provisioned number as claimed and (optionally) routed to an agent in one call.

Тело запроса

application/json Схема: NumberRegisterRequest

Ответы

Пример запроса

curl -X POST "https://api.voiceland.ai/v1/numbers/register" \
  -H "Authorization: Bearer VL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "agent": "front-desk",
  "e164": "+15550000009"
}'

Успешный ответ возвращает NumberRouteResponse.

Пример ответа

{
  "agent": "front-desk",
  "e164": "+15550000009"
}

DELETE /v1/numbers/{e164}#

Release a number. Returns a claimed number to the pool.

Параметры

Ответы

Пример запроса

curl -X DELETE "https://api.voiceland.ai/v1/numbers/{e164}" \
  -H "Authorization: Bearer VL_API_KEY"

POST /v1/numbers/{e164}/route#

Route a number to an agent. Binds a claimed number to an agent; calls to it reach that agent.

Параметры

Тело запроса

application/json Схема: NumberRouteRequest

Ответы

Пример запроса

curl -X POST "https://api.voiceland.ai/v1/numbers/{e164}/route" \
  -H "Authorization: Bearer VL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "agent": "front-desk"
}'

Успешный ответ возвращает NumberRouteResponse.

Пример ответа

{
  "agent": "front-desk",
  "e164": "+15550000001"
}

Схемы#

Error#

Error envelope returned for non-2xx responses.

NumberClaimRequest#

Claim a number. Empty body claims any available number.

NumberClaimResponse#

NumberRegisterRequest#

Register an externally-provisioned number as claimed (and optionally routed).

NumberRouteRequest#

NumberRouteResponse#