Voice Agent
AI phone assistant, analytics, and call logs
Authorization
ApiKeyAuth X-Api-Key<token>
API key obtained from the CMS dashboard.
In: header
Path Parameters
siteId*string
Response Body
application/json
curl -X GET "https://example.com/v1/sites/string/voice-agent/config"{
"data": {
"enabled": true,
"language": "string",
"greeting": "string",
"voiceId": "string",
"businessHours": {
"start": "string",
"end": "string",
"timezone": "string"
},
"afterHoursAction": "voicemail"
},
"meta": {
"requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
"timestamp": "2019-08-24T14:15:22Z"
}
}Authorization
ApiKeyAuth X-Api-Key<token>
API key obtained from the CMS dashboard.
In: header
Path Parameters
siteId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v1/sites/string/voice-agent/config" \ -H "Content-Type: application/json" \ -d '{}'{
"data": {
"enabled": true,
"language": "string",
"greeting": "string",
"voiceId": "string",
"businessHours": {
"start": "string",
"end": "string",
"timezone": "string"
},
"afterHoursAction": "voicemail"
},
"meta": {
"requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
"timestamp": "2019-08-24T14:15:22Z"
}
}{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
"timestamp": "2019-08-24T14:15:22Z"
}
}Authorization
ApiKeyAuth X-Api-Key<token>
API key obtained from the CMS dashboard.
In: header
Path Parameters
siteId*string
Query Parameters
period?string
Default
"30d"Value in
"7d" | "30d" | "90d"Response Body
application/json
curl -X GET "https://example.com/v1/sites/string/voice-agent/analytics"{
"data": {
"period": "string",
"totalCalls": 0,
"avgDurationSeconds": 0,
"missedCalls": 0,
"resolvedCalls": 0,
"topIntents": [
{
"intent": "string",
"count": 0
}
]
},
"meta": {
"requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
"timestamp": "2019-08-24T14:15:22Z"
}
}Authorization
ApiKeyAuth X-Api-Key<token>
API key obtained from the CMS dashboard.
In: header
Path Parameters
siteId*string
Query Parameters
status?string
Value in
"completed" | "missed" | "voicemail"limit?integer
Default
25Range
value <= 100cursor?string
Response Body
application/json
curl -X GET "https://example.com/v1/sites/string/voice-agent/calls"{
"data": [
{
"id": "string",
"direction": "inbound",
"status": "string",
"durationSeconds": 0,
"callerNumber": "string",
"intent": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"hasMore": true,
"nextCursor": "string",
"meta": {
"requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
"timestamp": "2019-08-24T14:15:22Z"
}
}Authorization
ApiKeyAuth X-Api-Key<token>
API key obtained from the CMS dashboard.
In: header
Path Parameters
siteId*string
Response Body
application/json
curl -X GET "https://example.com/v1/sites/string/voice-agent/usage"{
"data": {
"currentMonth": "string",
"totalMinutes": 0,
"budgetMinutes": 0,
"costEur": 0,
"budgetEur": 0
},
"meta": {
"requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
"timestamp": "2019-08-24T14:15:22Z"
}
}