Retrieve a session
Accepts either the session id (Mongo ObjectId) or the call id (numeric). If the id is purely numeric, the session is looked up by call.id.
curl --request GET \
--url https://platform.kinbox.com.br/v1/sessions/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://platform.kinbox.com.br/v1/sessions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.kinbox.com.br/v1/sessions/{id}', 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.kinbox.com.br/v1/sessions/{id}",
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.kinbox.com.br/v1/sessions/{id}"
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.kinbox.com.br/v1/sessions/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kinbox.com.br/v1/sessions/{id}")
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{
"id": "66e2f1c9a1b2c3d4e5f60718",
"_id": "66e2f1c9a1b2c3d4e5f60718",
"workspaceId": 1,
"call": {
"id": 987654,
"customerPlatformId": 1234567,
"workspacePlatformId": 103,
"operatorId": 42,
"groupId": 10,
"chatBotId": 123,
"lastBotId": 123,
"lastCallMessageId": 123,
"protocol": "2026091412345",
"uniqueIdentifier": "<string>",
"isFinished": false,
"isChatBotActive": false,
"isFromIntegration": false,
"isHidden": false,
"isImported": false,
"isReopened": false,
"isWithoutOperatorAnswer": false,
"isWithoutClientAnswer": false,
"isCreatedByActiveChat": false,
"isRatingActive": false,
"isNewContact": false,
"isNewConversation": false,
"hasScheduledAutomation": false,
"botLoopCount": 123,
"extraData": {},
"referral": {},
"customFields": {
"origem": {
"value": "site"
}
},
"createdAt": "2026-09-14T11:58:00.000Z",
"answeredAt": "2026-09-14T12:00:00.000Z",
"finishedAt": "2026-09-14T12:30:00.000Z",
"callExpiresAt": "<string>",
"firstOperatorMessageAt": "<string>",
"lastOperatorMessageAt": "<string>",
"firstCustomerMessageAt": "<string>",
"lastCustomerMessageAt": "<string>"
},
"createdAt": "2026-09-14T11:58:00.000Z",
"updatedAt": "2026-09-14T12:30:00.000Z",
"contact": {
"id": 555,
"name": "João Silva",
"avatar": "<string>",
"email": "joao@gmail.com",
"phone": "5585988887777",
"notes": "<string>",
"newContact": false,
"isPrivate": false,
"createdAt": "2026-01-10T10:00:00.000Z",
"customFields": {
"cpf": {
"value": "000.000.000-00"
}
}
},
"conversation": {
"id": 1234567,
"customerId": 123,
"platformId": 123,
"workspacePlatformId": 103,
"identifier": "5585988887777",
"uniqueIdentifier": "<string>",
"lastCallId": 123,
"origin": "<string>",
"newCustomer": false,
"hasNewMessages": false,
"showPending": false,
"wasImported": false,
"isDbMigrated": false,
"isBlocked": false,
"isGroup": false,
"importationTimestamp": 123,
"createdAt": "<string>",
"lastSeen": "<string>",
"customerLastSeen": "<string>",
"lastMessageAt": "<string>",
"customerLastMessageAt": "<string>",
"operatorLastMessageAt": "<string>",
"operatorLastMessageTriggerAt": "<string>",
"pendingAt": "<string>",
"expirationDate": "<string>"
},
"lastMessage": {
"idMessage": 37826587,
"_id": "<string>",
"operatorId": 123,
"content": "[{\"insert\":\"Olá\"}]",
"type": 0,
"createdAt": "2026-09-14T12:30:00.000Z"
},
"rating": {
"value": 5,
"operatorId": 123,
"operatorName": "<string>"
},
"trails": [
{
"date": "2026-09-14T12:00:00.000Z",
"isodate": "2026-09-14T12:00:00.000Z",
"type": "operator",
"id": 42
}
],
"interactions": [
{
"date": "2026-09-14T12:00:00.000Z",
"operatorId": 42
}
],
"interactionDates": [
"2026-09-14"
],
"tags": [
3,
8
],
"followers": [
123
],
"scheduledMessages": [
123
],
"deals": {},
"operatorMessagesCount": 4,
"assignedOperatorMessagesCount": 4,
"botMessagesCount": 2,
"contactMessagesCount": 5,
"totalMessagesCount": 11,
"messagesCountByDate": {
"2026-09-14": {
"bot": 2,
"operator": 4,
"contact": 5
}
},
"tma": 1800,
"tme": 120,
"tmp": 90,
"tmpResetOnNewAssignment": false,
"summary": "<string>",
"campaignId": "<string>",
"mergedFromCustomerId": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Id da sessão (ObjectId)
"66e2f1c9a1b2c3d4e5f60718"
"66e2f1c9a1b2c3d4e5f60718"
1
Show child attributes
Show child attributes
"2026-09-14T11:58:00.000Z"
"2026-09-14T12:30:00.000Z"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Histórico de quem assumiu a sessão
Show child attributes
Show child attributes
Show child attributes
Show child attributes
["2026-09-14"]
Ids das tags da sessão
[3, 8]
Ids dos operadores seguindo a conversa
Ids das mensagens agendadas
Negócios (deals) vinculados
4
4
2
5
11
Contagem de mensagens por dia: { "2026-09-14": { bot, operator, contact } }
{
"2026-09-14": { "bot": 2, "operator": 4, "contact": 5 }
}
Tempo médio de atendimento, em segundos
1800
Tempo médio de espera, em segundos
120
Tempo de primeira resposta, em segundos
90
false
Resumo da sessão gerado por IA
Id da campanha que originou a sessão
curl --request GET \
--url https://platform.kinbox.com.br/v1/sessions/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://platform.kinbox.com.br/v1/sessions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.kinbox.com.br/v1/sessions/{id}', 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.kinbox.com.br/v1/sessions/{id}",
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.kinbox.com.br/v1/sessions/{id}"
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.kinbox.com.br/v1/sessions/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kinbox.com.br/v1/sessions/{id}")
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{
"id": "66e2f1c9a1b2c3d4e5f60718",
"_id": "66e2f1c9a1b2c3d4e5f60718",
"workspaceId": 1,
"call": {
"id": 987654,
"customerPlatformId": 1234567,
"workspacePlatformId": 103,
"operatorId": 42,
"groupId": 10,
"chatBotId": 123,
"lastBotId": 123,
"lastCallMessageId": 123,
"protocol": "2026091412345",
"uniqueIdentifier": "<string>",
"isFinished": false,
"isChatBotActive": false,
"isFromIntegration": false,
"isHidden": false,
"isImported": false,
"isReopened": false,
"isWithoutOperatorAnswer": false,
"isWithoutClientAnswer": false,
"isCreatedByActiveChat": false,
"isRatingActive": false,
"isNewContact": false,
"isNewConversation": false,
"hasScheduledAutomation": false,
"botLoopCount": 123,
"extraData": {},
"referral": {},
"customFields": {
"origem": {
"value": "site"
}
},
"createdAt": "2026-09-14T11:58:00.000Z",
"answeredAt": "2026-09-14T12:00:00.000Z",
"finishedAt": "2026-09-14T12:30:00.000Z",
"callExpiresAt": "<string>",
"firstOperatorMessageAt": "<string>",
"lastOperatorMessageAt": "<string>",
"firstCustomerMessageAt": "<string>",
"lastCustomerMessageAt": "<string>"
},
"createdAt": "2026-09-14T11:58:00.000Z",
"updatedAt": "2026-09-14T12:30:00.000Z",
"contact": {
"id": 555,
"name": "João Silva",
"avatar": "<string>",
"email": "joao@gmail.com",
"phone": "5585988887777",
"notes": "<string>",
"newContact": false,
"isPrivate": false,
"createdAt": "2026-01-10T10:00:00.000Z",
"customFields": {
"cpf": {
"value": "000.000.000-00"
}
}
},
"conversation": {
"id": 1234567,
"customerId": 123,
"platformId": 123,
"workspacePlatformId": 103,
"identifier": "5585988887777",
"uniqueIdentifier": "<string>",
"lastCallId": 123,
"origin": "<string>",
"newCustomer": false,
"hasNewMessages": false,
"showPending": false,
"wasImported": false,
"isDbMigrated": false,
"isBlocked": false,
"isGroup": false,
"importationTimestamp": 123,
"createdAt": "<string>",
"lastSeen": "<string>",
"customerLastSeen": "<string>",
"lastMessageAt": "<string>",
"customerLastMessageAt": "<string>",
"operatorLastMessageAt": "<string>",
"operatorLastMessageTriggerAt": "<string>",
"pendingAt": "<string>",
"expirationDate": "<string>"
},
"lastMessage": {
"idMessage": 37826587,
"_id": "<string>",
"operatorId": 123,
"content": "[{\"insert\":\"Olá\"}]",
"type": 0,
"createdAt": "2026-09-14T12:30:00.000Z"
},
"rating": {
"value": 5,
"operatorId": 123,
"operatorName": "<string>"
},
"trails": [
{
"date": "2026-09-14T12:00:00.000Z",
"isodate": "2026-09-14T12:00:00.000Z",
"type": "operator",
"id": 42
}
],
"interactions": [
{
"date": "2026-09-14T12:00:00.000Z",
"operatorId": 42
}
],
"interactionDates": [
"2026-09-14"
],
"tags": [
3,
8
],
"followers": [
123
],
"scheduledMessages": [
123
],
"deals": {},
"operatorMessagesCount": 4,
"assignedOperatorMessagesCount": 4,
"botMessagesCount": 2,
"contactMessagesCount": 5,
"totalMessagesCount": 11,
"messagesCountByDate": {
"2026-09-14": {
"bot": 2,
"operator": 4,
"contact": 5
}
},
"tma": 1800,
"tme": 120,
"tmp": 90,
"tmpResetOnNewAssignment": false,
"summary": "<string>",
"campaignId": "<string>",
"mergedFromCustomerId": "<string>"
}