Skip to main content
POST
/
v1
/
dni-reservation
Reserve a DNI (Dynamic Number Insertion) for an incoming call.
curl --request POST \
  --url https://api.us-1.platform.polyai.app/v1/dni-reservation \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "attributes": {
    "shared_id": "1234",
    "customer": {
      "address": "test lane",
      "age": 25
    },
    "previous_calls": [
      "call_id_1",
      "call_id_2"
    ]
  }
}
'
{
  "dni": "+12345"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
attributes
object
required

Attributes that will be consumed by the virtual agent. Flexible mapping of key → value.

Example:
{
  "shared_id": "1234",
  "customer": { "address": "test lane", "age": 25 },
  "previous_calls": ["call_id_1", "call_id_2"]
}

Response

Successfully reserved a DNI.

​
dni
string

The reserved DNI identifier.