Reserve a DNI (Dynamic Number Insertion) for an incoming call.

Reserves a DNI, associating a temporary set of attributes to a specific virtual agent.

post/v1/conversations/dni-reservation

Request

Base URL
https://api.us.poly.ai
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/poly/apis/polyai-agents-api/docs/v1/conversations/dni-reservation/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

attributesobject required

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

Example request

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

Response

Successfully reserved a DNI.

dnistring

The reserved DNI identifier.

Changes

No recorded changes to this operation across all 1 revision of this API.