Get handoff state

Returns the stored handoff state for a conversation. At least one of id or shared_id must be provided as a query parameter. If both are provided, shared_id takes precedence.

GET /v1/{account_id}/{project_id}/handoff_state

Get handoff state information for a call.

cURL

curl --request GET \
  --url https://api.us-1.platform.polyai.app/v1/{account_id}/{project_id}/handoff_state \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.us-1.platform.polyai.app/v1/{account_id}/{project_id}/handoff_state"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.us-1.platform.polyai.app/v1/{account_id}/{project_id}/handoff_state', 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/{account_id}/{project_id}/handoff_state",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.us-1.platform.polyai.app/v1/{account_id}/{project_id}/handoff_state"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.us-1.platform.polyai.app/v1/{account_id}/{project_id}/handoff_state")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.us-1.platform.polyai.app/v1/{account_id}/{project_id}/handoff_state")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

200

{
  "id": "0bba04d7-38b3-4fd3-a1a8-329c34517fc1",
  "data": {
    "customer_id": "12345",
    "handoff_reason": "successfully_identified"
  },
  "shared_id": "acme_inc_sdklfasdklfjasbdfklabs"
}

{
  "error_message": "<string>"
}

{
  "error_message": "<string>"
}

{
  "error_message": "<string>"
}

{
  "error_message": "<string>"
}

{
  "error_message": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

account_id · string · required

PolyAI account ID.

project_id · string · required

PolyAI project ID.

Query Parameters

id · string

PolyAI conversation ID. Either id or shared_id must be provided.

shared_id · string

Shared identifier used by the integrator. Either id or shared_id must be provided. If both are present, shared_id is used.

Response

200

application/json

Handoff state successfully retrieved.

id · string · required

PolyAI conversation ID.

Example:

"0bba04d7-38b3-4fd3-a1a8-329c34517fc1"

data · object · required

Arbitrary key–value data stored for this conversation, typically used by the downstream platform.

Example:

{
  "customer_id": "12345",
  "handoff_reason": "successfully_identified"
}

shared_id · string

Shared ID associated with the conversation (if present).

Example:

"acme_inc_sdklfasdklfjasbdfklabs"