API ReferenceSessions
/public/sessions
Authorization
ApiKeyAuth X-Api-Key<token>
API key for authentication. Passed as a header on every request.
In: header
Query Parameters
pageIndex?integer
Format
int32pageSize?integer
Format
int32companionId?string
externalClientId?string
sessionType?string
Value in
"voip" | "sip" | "webrtc" | "websocket"search?string
tags?
Header Parameters
X-API-Version?string
Response Body
curl -X GET "https://companion-api.napster.com/public/sessions"{
"items": [
{
"id": "string",
"companion": {
"id": "string",
"avatarId": "string",
"organizationId": "string",
"firstName": "string",
"lastName": "string"
},
"functions": [
"string"
],
"knowledgeBase": {
"id": "string",
"name": "string"
},
"faqCollections": [
{
"id": "string",
"name": "string"
}
],
"companionId": "string",
"knowledgeBaseId": "string",
"faqIds": [
"string"
],
"externalClientId": "string",
"tags": {
"property1": "string",
"property2": "string"
},
"sessionType": "voip",
"status": "pending",
"createdAt": 0,
"startedAt": 0,
"closedAt": 0,
"closeReason": "string"
}
],
"filteredCount": 0,
"totalCount": 0,
"pageIndex": 0,
"pageSize": 0,
"search": "string"
}{
"code": "string",
"description": "string",
"type": "failure",
"numericType": 0
}