v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
Transcriptions & Sentiment
44.3

Read Transcription for Specific Call

get/domains/{domain}/transcriptions

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com

Query parameters

idnumber required

The Job Id of the recording transcription. Required to be given on request. ID can be found in CDR read when available using field "call-intelligence-job-id"

datestring required

The date will help identify the year and month of the call to limit the search down. The format will be YYYYMM

callidstring required

One callid_id needs to be provided that can be linked to the domain of the call> you can use any of the fields orig_callid, term_callid, by_callid or if you dont know which one you have just callid though callid might have additional DB lookups.

orig_callidstring

One callid_id needs to be provided that can be linked to the domain of the call> you can use any of the fields orig_callid, term_callid, by_callid or if you dont know which one you have just callid though callid might have additional DB lookups.

term_callidstring

One callid_id needs to be provided that can be linked to the domain of the call> you can use any of the fields orig_callid, term_callid, by_callid or if you dont know which one you have just callid though callid might have additional DB lookups.

by_callidstring

One callid_id needs to be provided that can be linked to the domain of the call> you can use any of the fields orig_callid, term_callid, by_callid or if you dont know which one you have just callid though callid might have additional DB lookups.

Response

call-intelligence-job-idinteger

This is the main ID identifying the transcription job and will link all intelligence features.

call-intelligence-processing-statusstring

This is the status of the transcription and intelegence work. The data will be enter as soon as the request is made to remote vendor, but might not be availabel fully untill status is "finished"

created-datetimestring da

The date-time of the request for transcription.

call-idstring

The linked call-id for the SIP call being recorded. Could be an orig_callid or term_callid depending on who requested recording and type of call.

call-intelligence-features-enabledstring

List of features enabled for request.

call-intelligence-summarystring

The main summary of the call when available.

call-intelligence-topics-topstring[]

The list of top topics detected on the call based on frequency.

call-intelligence-duration-secondsnumber

The duration in seconds for the length of time where detected voice was seen.

call-intelligence-duration-seconds-negativeinteger

The duration in seconds for the length of time where detected voice was seen with a Negative sentiment

call-intelligence-duration-seconds-neutralnumber

The duration in seconds for the length of time where detected voice was seen.

call-intelligence-duration-seconds-positivenumber

The duration in seconds for the length of time where detected voice was seen with a Positve sentiment

call-intelligence-ending-duration-secondsnumber
call-intelligence-ending-duration-seconds-negativeinteger
call-intelligence-ending-duration-seconds-neutralnumber
call-intelligence-ending-duration-seconds-positivenumber
call-intelligence-ending-percent-negativeinteger
call-intelligence-ending-percent-neutralinteger
call-intelligence-ending-percent-positiveinteger
call-intelligence-ending-sentiment-scaleinteger
call-intelligence-percent-negativeinteger
call-intelligence-percent-neutralinteger
call-intelligence-percent-positiveinteger
call-intelligence-summary-statusstring
call-intelligence-topics-allstring[]

The complete list of detected topics in the conversation

errorsstring

If errors are present it will display here.

last-modified-datetimestring date

The modified time of the transcription job. Difference between this and created-datetime will be the duration of the job in most cases.

Example response

{
  "call-intelligence-job-id": 179133950,
  "call-intelligence-processing-status": "finished",
  "created-datetime": "2024-10-01T22:48:21+00:00",
  "last-modified-datetime": "2024-10-01T22:48:28+00:00"
}