List conversation handoffs
Use to investigate escalation reasons, captured/missing handoff fields, notification events and handoff/review resolutions for one conversation. Discover conversationId with list_conversations. Action execution receipts are separate in list_action_executions. Requires conversations:read. Returns a paginated combined window of handoff and review cases: default/max 30 total cases, ordered by creation time then stored identity, newest first. Follow nextCursor with the same conversation and limit until hasMore=false. Each case contains its latest five events in chronological order, eventsHasMore and eventsNextCursor for list_conversation_handoff_events. Resolution details are fetched independently of the preview. Captured/missing fields, property/working-hours context and resolution remain available. Cases/events can change during reads; deduplicate identities. Check current conversation handoffStatus/activeHandoffCaseId for current ownership, which may not be on a historical page. Reads never resolve a case or send a notification.
curl --request GET \
--url https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/handoffs \
--header 'Authorization: Bearer <token>'import requests
url = "https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/handoffs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/handoffs', 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://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/handoffs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/handoffs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/handoffs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/handoffs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"limit": 123,
"hasMore": true,
"nextCursor": "<string>",
"conversationId": "<string>",
"conversationKey": "<string>",
"handoffs": [
{
"caseId": "<string>",
"status": "requested",
"reasonCode": "<string>",
"operatorNote": "<string>",
"requestedAt": "<string>",
"resolvedAt": "<string>",
"events": [
{
"eventType": "<string>",
"actorType": "ai",
"at": "2023-11-07T05:31:56Z",
"payload": {},
"eventId": "<string>",
"payloadStatus": "available"
}
],
"titleKey": "<string>",
"titleFallback": "<string>",
"intentId": "<string>",
"propertyId": "<string>",
"propertyDisplayName": "<string>",
"severity": "hard",
"requiredFields": [
"<string>"
],
"capturedFields": {},
"capturedFieldsDisplay": [
{
"id": "<string>",
"label": "<string>",
"value": "<string>"
}
],
"missingFieldsDisplay": [
{
"id": "<string>",
"label": "<string>"
}
],
"policyVersion": "<string>",
"handoffAvailability": {
"status": "within_hours",
"timezone": "<string>",
"evaluatedAtLocal": "<string>",
"currentWindow": {
"date": "<string>",
"day": "<string>",
"start": "<string>",
"end": "<string>"
},
"nextWindow": {
"date": "<string>",
"day": "<string>",
"start": "<string>",
"end": "<string>"
}
},
"channel": "whatsapp",
"simulation": true,
"resolution": {
"operatorId": "<string>",
"operatorName": "<string>",
"operatorEmail": "<string>",
"resolutionNote": "<string>",
"resolvedAt": "2023-11-07T05:31:56Z"
},
"eventsHasMore": true,
"eventsNextCursor": "<string>",
"resolutionDetailsStatus": "available"
}
],
"reviews": [
{
"caseId": "<string>",
"status": "requested",
"reasonCode": "<string>",
"note": "<string>",
"requestedByOperatorId": "<string>",
"requestedByOperatorName": "<string>",
"assignedOperatorId": "<string>",
"assignedOperatorName": "<string>",
"requestedAt": "2023-11-07T05:31:56Z",
"resolvedAt": "2023-11-07T05:31:56Z",
"resolution": {
"operatorId": "<string>",
"operatorName": "<string>",
"operatorEmail": "<string>",
"resolutionNote": "<string>",
"resolvedAt": "2023-11-07T05:31:56Z"
},
"events": [
{
"eventType": "<string>",
"actorType": "ai",
"at": "2023-11-07T05:31:56Z",
"payload": {},
"eventId": "<string>",
"payloadStatus": "available"
}
],
"eventsHasMore": true,
"eventsNextCursor": "<string>",
"resolutionDetailsStatus": "available"
}
]
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}Autorizaciones
Server-side tenant-scoped credential created from Build > API Keys.
Parámetros de ruta
Stored conversationId from list_conversations; keep the connected business and conversation unchanged for continuation reads.
Parámetros de consulta
1 <= x <= 301 - 2048^[a-zA-Z0-9_-]+$curl --request GET \
--url https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/handoffs \
--header 'Authorization: Bearer <token>'import requests
url = "https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/handoffs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/handoffs', 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://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/handoffs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/handoffs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/handoffs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/conversations/{conversationId}/handoffs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"limit": 123,
"hasMore": true,
"nextCursor": "<string>",
"conversationId": "<string>",
"conversationKey": "<string>",
"handoffs": [
{
"caseId": "<string>",
"status": "requested",
"reasonCode": "<string>",
"operatorNote": "<string>",
"requestedAt": "<string>",
"resolvedAt": "<string>",
"events": [
{
"eventType": "<string>",
"actorType": "ai",
"at": "2023-11-07T05:31:56Z",
"payload": {},
"eventId": "<string>",
"payloadStatus": "available"
}
],
"titleKey": "<string>",
"titleFallback": "<string>",
"intentId": "<string>",
"propertyId": "<string>",
"propertyDisplayName": "<string>",
"severity": "hard",
"requiredFields": [
"<string>"
],
"capturedFields": {},
"capturedFieldsDisplay": [
{
"id": "<string>",
"label": "<string>",
"value": "<string>"
}
],
"missingFieldsDisplay": [
{
"id": "<string>",
"label": "<string>"
}
],
"policyVersion": "<string>",
"handoffAvailability": {
"status": "within_hours",
"timezone": "<string>",
"evaluatedAtLocal": "<string>",
"currentWindow": {
"date": "<string>",
"day": "<string>",
"start": "<string>",
"end": "<string>"
},
"nextWindow": {
"date": "<string>",
"day": "<string>",
"start": "<string>",
"end": "<string>"
}
},
"channel": "whatsapp",
"simulation": true,
"resolution": {
"operatorId": "<string>",
"operatorName": "<string>",
"operatorEmail": "<string>",
"resolutionNote": "<string>",
"resolvedAt": "2023-11-07T05:31:56Z"
},
"eventsHasMore": true,
"eventsNextCursor": "<string>",
"resolutionDetailsStatus": "available"
}
],
"reviews": [
{
"caseId": "<string>",
"status": "requested",
"reasonCode": "<string>",
"note": "<string>",
"requestedByOperatorId": "<string>",
"requestedByOperatorName": "<string>",
"assignedOperatorId": "<string>",
"assignedOperatorName": "<string>",
"requestedAt": "2023-11-07T05:31:56Z",
"resolvedAt": "2023-11-07T05:31:56Z",
"resolution": {
"operatorId": "<string>",
"operatorName": "<string>",
"operatorEmail": "<string>",
"resolutionNote": "<string>",
"resolvedAt": "2023-11-07T05:31:56Z"
},
"events": [
{
"eventType": "<string>",
"actorType": "ai",
"at": "2023-11-07T05:31:56Z",
"payload": {},
"eventId": "<string>",
"payloadStatus": "available"
}
],
"eventsHasMore": true,
"eventsNextCursor": "<string>",
"resolutionDetailsStatus": "available"
}
]
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}