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#