Reserve DNI

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

POST /v1/conversations/dni-reservation

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

cURL

curl --request POST \
  --url https://api.us-1.platform.polyai.app/v1/conversations/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"
    ]
  }
}
'

import requests

url = "https://api.us-1.platform.polyai.app/v1/conversations/dni-reservation"

payload = { "attributes": {
        "shared_id": "1234",
        "customer": {
            "address": "test lane",
            "age": 25
        },
        "previous_calls": ["call_id_1", "call_id_2"]
    } }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    attributes: {
      shared_id: '1234',
      customer: {address: 'test lane', age: 25},
      previous_calls: ['call_id_1', 'call_id_2']
    }
  })
};

fetch('https://api.us-1.platform.polyai.app/v1/conversations/dni-reservation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.us-1.platform.polyai.app/v1/conversations/dni-reservation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'attributes' => [
        'shared_id' => '1234',
        'customer' => [
                'address' => 'test lane',
                'age' => 25
        ],
        'previous_calls' => [
                'call_id_1',
                'call_id_2'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.us-1.platform.polyai.app/v1/conversations/dni-reservation"

	payload := strings.NewReader("{\n  \"attributes\": {\n    \"shared_id\": \"1234\",\n    \"customer\": {\n      \"address\": \"test lane\",\n      \"age\": 25\n    },\n    \"previous_calls\": [\n      \"call_id_1\",\n      \"call_id_2\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.us-1.platform.polyai.app/v1/conversations/dni-reservation")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"attributes\": {\n    \"shared_id\": \"1234\",\n    \"customer\": {\n      \"address\": \"test lane\",\n      \"age\": 25\n    },\n    \"previous_calls\": [\n      \"call_id_1\",\n      \"call_id_2\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.us-1.platform.polyai.app/v1/conversations/dni-reservation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"attributes\": {\n    \"shared_id\": \"1234\",\n    \"customer\": {\n      \"address\": \"test lane\",\n      \"age\": 25\n    },\n    \"previous_calls\": [\n      \"call_id_1\",\n      \"call_id_2\"\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "dni": "+12345"
}

{
  "success": false,
  "error": "Bad Request",
  "message": "error message"
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "error message"
}

{
  "success": false,
  "error": "Not Found",
  "message": "no available route found"
}

{
  "success": false,
  "error": "Internal Server Error",
  "message": "error message"
}

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

200

application/json

Successfully reserved a DNI.

dni · string

The reserved DNI identifier.