v1

latestOpenAPI 3.1.02026-07-2687120159.0 KB

Get handoff state information for a call.

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

Path parameters

account_idstring required

PolyAI account ID.

project_idstring required

PolyAI project ID.

Query parameters

idstring

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

shared_idstring

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

Response

Handoff state successfully retrieved.

idstring required

PolyAI conversation ID.

shared_idstring

Shared ID associated with the conversation (if present).

dataobject required

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

Example response

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