GitHubContribute in GitHub: Edit online

copyright: years: 2017, 2018, 2019 lastupdated: "2023-02-12"


Voice Agent Insights REST API

Note that Voice Agent Insights is currently in alpha. For more information, see the Voice Agent Insights announcement.

REST API supported by Voice Agent Insights described by OpenAPI specification. For more information, see https://localhost:9443/openapi/ui/ or https://localhost:9443/openapi/.

The dashboard UI uses the same REST APIs to acquire and present data.

  • To list voice agents from the configuration:
   /va.insights/api/v1/agent
  • To get the Call Detail Records for the specified agent based of the query parameters:
   /va.insights/api/v1/agent/{agent-uri}/call/cdr/partial
	?startTime=&endTime=&sort=&direction=asc&pageSize=
         &bookmark=&endReason=&searchFilterCategory=&searchFilterValue=
         ```
         Specify `&direction=asc` for ascending; an empty value or any other value will be descending.

* To get the list of transcriptions for the specified agent that occurred for a specific session:

/va.insights/api/v1/agent/{agent-uri}/call/transcription ?globalSessionID=&bookmark= ```

  • To get Call Detail Records for the specified agent for a document:
   /va.insights/api/v1/agent/{agent-uri}/call/cdr/full
        ?documentID=
  • To get statistical information about calls made to the specified Voice Agent within the date range:
   /va.insights/api/v1/agent/{agent-uri}/call/cdr/summary
      ?startTime=&endTime=