DocumentationAPI ReferenceChangelog

Envocal API

API Reference API Changelog

Endpoints

Get a conversation GETList conversations of a tenant GET
Conversations

List conversations of a tenant

Get a conversation GET

Who talked to which agent and when, the transcript, the summary and how it ended.

Get usage of a tenant GET

Usage in a period for billing: voice conversations (phone and web voice) in time, text chats in input and output tokens. Lines are per agent and knowledge-base state, and every total is split into with and without knowledge base, so different per-minute prices can be applied.

GET
/v1/tenants/{tenantId}/conversations

Newest first, paged. Combine the filters as needed. Get one conversation for its transcript and summary.

Required permission: conversations:read

Authorization

Bearer
headerAuthorizationBearer <token>

Tenant API key (evk_…), created in Studio → Vault → API keys.

Path Parameters

tenantId*string

Tenant id, or current for the key's own tenant. Must be the key's tenant or one of its sub-tenants.

Query Parameters

agentName?string

Only conversations whose agent name contains this text.

channels?array<string>

Only these channels; repeat the parameter for several (?channels=phone&channels=text_chat). Values: phone, voice_chat, text_chat (older data may contain text_voice_chat).

startFrom?string

Only conversations that started at or after this time (ISO 8601).

Formatdate-time
startTo?string

Only conversations that started at or before this time (ISO 8601).

Formatdate-time
page?integer

Page number, starting at 1.

Formatint32
Default1
pageSize?integer

Items per page, 1–200. Default 10.

Formatint32
Default10

Response Body

One page of conversations.

  1. response
  1. response
  2. …

One page of results.

items*array<>

The items on this page.

page?integer

Page number, starting at 1.

Formatint32
pageSize?integer

Items per page.

Formatint32
totalCount?integer

Total number of items across all pages.

Formatint32
Example Request
curl -X GET 'https://api.envocal.ai/v1/tenants/string/conversations'
Example Response
{  "items": [    {      "id": "string",      "tenantId": "string",      "agentId": "string",      "agentName": "string",      "channel": "string",      "startUtc": "2019-08-24T14:15:22Z",      "endUtc": "2019-08-24T14:15:22Z",      "duration": 0,      "result": "string",      "topic": "string",      "sentiment": "string"    }  ],  "page": 0,  "pageSize": 0,  "totalCount": 0}
Example Request
curl -X GET 'https://api.envocal.ai/v1/tenants/string/conversations'
{
  "items": [
    {
      "id": "string",
      "tenantId": "string",
      "agentId": "string",
      "agentName": "string",
      "channel": "string",
      "startUtc": "2019-08-24T14:15:22Z",
      "endUtc": "2019-08-24T14:15:22Z",
      "duration": 0,
      "result": "string",
      "topic": "string",
      "sentiment": "string"
    }
  ],
  "page": 0,
  "pageSize": 0,
  "totalCount": 0
}