Skip to navigation
API ReferenceDni

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

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

Authentication

X-API-KEYstring

PolyAI API key. Send it in the X-API-KEY header.

Request

This endpoint expects an object.
attributesmap from strings to anyRequired

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

Response

Successfully reserved a DNI.
dnistringOptional
The reserved DNI identifier.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error