Read Transcription for Specific Call

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

domain

string

required

Example:

example.com

Query Params

number

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"

Example:

423542156

date

string

required

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

Example:

202405

callid

string

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.

Example:

20241001224534015297-092d2c5baad20a2a3e5ae22b849b5e6

orig_callid

string

optional

Example:

453691718_66427591@4.55.78.161

term_callid

string

optional

Example:

20241001224534015297-092d2c5baad20a2a3e5ae22b849b5e6

by_callid

string

optional

Example:

20241001224534015293-092d2c5baad20a2a3e5ae22b849b5e6c

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

call-intelligence-job-id

integer

read-onlyoptional

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

Example:

179133950

call-intelligence-processing-status

string

read-onlyoptional

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"

Example:

finished

created-datetime

string <da>

read-onlyoptional

The date-time of the request for transcription.

Example:

2024-10-01T22:48:21+00:00

call-id

string

optional

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-enabled

string

optional

List of features enabled for request.

call-intelligence-summary

string

optional

The main summary of the call when available.

call-intelligence-topics-top

array[string]

optional

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

call-intelligence-duration-seconds

number

optional

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

call-intelligence-duration-seconds-negative

integer

optional

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

call-intelligence-duration-seconds-neutral

number

optional

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

call-intelligence-duration-seconds-positive

number

optional

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

call-intelligence-ending-duration-seconds

number

optional

call-intelligence-ending-duration-seconds-negative

integer

optional

call-intelligence-ending-duration-seconds-neutral

number

optional

call-intelligence-ending-duration-seconds-positive

number

optional

call-intelligence-ending-percent-negative

integer

optional

call-intelligence-ending-percent-neutral

integer

optional

call-intelligence-ending-percent-positive

integer

optional

call-intelligence-ending-sentiment-scale

integer

optional

call-intelligence-percent-negative

integer

optional

call-intelligence-percent-neutral

integer

optional

call-intelligence-percent-positive

integer

optional

call-intelligence-segments

array [object {5}]

optional

speaker

string

required

comment

string

required

sentiment

string

required

start-time

string

required

end-time

string

required

call-intelligence-summary-status

string

optional

call-intelligence-topics-all

array[string]

optional

The complete list of detected topics in the conversation

errors

string

optional

If errors are present it will display here.

last-modified-datetime

string <date>

optional

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

Example:

2024-10-01T22:48:28+00:00

Example

{
  "call-intelligence-job-id": 179133950,
  "call-intelligence-processing-status": "finished",
  "created-datetime": "2024-10-01T22:48:21+00:00",
  "call-id": "20241001224534015297-092d2c5baad20a2a3e5ae22b849b5e6c",
  "call-intelligence-features-enabled": "transcription,sentiment,summary,topics",
  "call-intelligence-summary": "The customer calls Acme Automotive about a taillight part that hasn't arrived for their Toyota 4 Runner. The agent asks for the order number and confirms the part is for a RAV 4. The agent checks the system and confirms that the part should be sent later in the week. The call ends with the agent thanking the customer for their call and saying goodbye.",
  "call-intelligence-topics-top": [
    "part order",
    "taillight",
    "toyota 4 runner"
  ],
  "call-intelligence-duration-seconds": 82.76,
  "call-intelligence-duration-seconds-negative": 0,
  "call-intelligence-duration-seconds-neutral": 75.5,
  "call-intelligence-duration-seconds-positive": 7.26,
  "call-intelligence-ending-duration-seconds": 31.79,
  "call-intelligence-ending-duration-seconds-negative": 0,
  "call-intelligence-ending-duration-seconds-neutral": 27.99,
  "call-intelligence-ending-duration-seconds-positive": 3.8,
  "call-intelligence-ending-percent-negative": 0,
  "call-intelligence-ending-percent-neutral": 88,
  "call-intelligence-ending-percent-positive": 12,
  "call-intelligence-ending-sentiment-scale": 0,
  "call-intelligence-percent-negative": 0,
  "call-intelligence-percent-neutral": 91,
  "call-intelligence-percent-positive": 9,
  "call-intelligence-segments": [
    {
      "speaker": "sip:2000@netsapiens",
      "comment": "Hello, and thanks for calling Acme Automotive. How can I help you today?",
      "sentiment": "Positive",
      "start-time": "00:00:01,04",
      "end-time": "00:00:04,50"
    },
    {
      "speaker": "sip:+18589267933@192.81.237.20",
      "comment": "Yeah. Hi. I\\'m calling about this taillight that I ordered, and I can\\'t seem to get it to work.",
      "sentiment": "Neutral",
      "start-time": "00:00:05,12",
      "end-time": "00:00:11,13"
    },
    {
      "speaker": "sip:2000@netsapiens",
      "comment": "Alright. So you\\'re calling about a part order. Let me, go ahead and check that out. Okay? Do you have an order number on",
      "sentiment": "Neutral",
      "start-time": "00:00:11,44",
      "end-time": "00:00:17,59"
    },
    {
      "speaker": "sip:+18589267933@192.81.237.20",
      "comment": "Yeah. Yeah. I do. Hold on. So, let me pull it up. My order number is a as in apple, 9 1 6 4 2 1 1.",
      "sentiment": "Neutral",
      "start-time": "00:00:17,89",
      "end-time": "00:00:27,27"
    },
    {
      "speaker": "sip:2000@netsapiens",
      "comment": "you?",
      "sentiment": "Neutral",
      "start-time": "00:00:18,05",
      "end-time": "00:00:18,55"
    },
    {
      "speaker": "sip:2000@netsapiens",
      "comment": "Alright. Thanks. Let me enter that here.",
      "sentiment": "Neutral",
      "start-time": "00:00:28,05",
      "end-time": "00:00:30,31"
    },
    {
      "speaker": "sip:2000@netsapiens",
      "comment": "Okay. Yeah. I see that. So it, you didn\\'t get the part? It hasn\\'t arrived yet? Is that what you\\'re suggesting?",
      "sentiment": "Neutral",
      "start-time": "00:00:32,10",
      "end-time": "00:00:39,00"
    },
    {
      "speaker": "sip:+18589267933@192.81.237.20",
      "comment": "No. I got the part, but it won\\'t plug in to my Toyota. It seems like it\\'s a part for a different car maybe.",
      "sentiment": "Neutral",
      "start-time": "00:00:39,86",
      "end-time": "00:00:47,08"
    },
    {
      "speaker": "sip:2000@netsapiens",
      "comment": "Oh, okay. What model Toyota do you have?",
      "sentiment": "Neutral",
      "start-time": "00:00:47,47",
      "end-time": "00:00:50,77"
    },
    {
      "speaker": "sip:+18589267933@192.81.237.20",
      "comment": "A 4 Runner.",
      "sentiment": "Neutral",
      "start-time": "00:00:51,72",
      "end-time": "00:00:52,62"
    },
    {
      "speaker": "sip:2000@netsapiens",
      "comment": "4 Runner. Great car. Okay. Let me check that.",
      "sentiment": "Neutral",
      "start-time": "00:00:52,83",
      "end-time": "00:00:56,61"
    },
    {
      "speaker": "sip:2000@netsapiens",
      "comment": "Yes. That does look like that\\'s a part for a RAV 4, which will not work.",
      "sentiment": "Neutral",
      "start-time": "00:00:58,89",
      "end-time": "00:01:04,19"
    },
    {
      "speaker": "sip:+18589267933@192.81.237.20",
      "comment": "That would explain it. Okay.",
      "sentiment": "Neutral",
      "start-time": "00:01:04,62",
      "end-time": "00:01:06,24"
    },
    {
      "speaker": "sip:2000@netsapiens",
      "comment": "Let me go ahead and ship you a new part, for your Toyota 4 Runner.",
      "sentiment": "Neutral",
      "start-time": "00:01:04,89",
      "end-time": "00:01:10,19"
    },
    {
      "speaker": "sip:2000@netsapiens",
      "comment": "Let me see if I can do that. Yep. No problem. I have that in my system. That should go out later this week. Is there anything that I can help you with? Anything else I can help you with? Okay.",
      "sentiment": "Neutral",
      "start-time": "00:01:11,86",
      "end-time": "00:01:22,20"
    },
    {
      "speaker": "sip:+18589267933@192.81.237.20",
      "comment": "That\\'s great.",
      "sentiment": "Neutral",
      "start-time": "00:01:18,50",
      "end-time": "00:01:19,48"
    },
    {
      "speaker": "sip:+18589267933@192.81.237.20",
      "comment": "No. That\\'s awesome. That\\'s exactly what I needed. I appreciate the help.",
      "sentiment": "Neutral",
      "start-time": "00:01:20,34",
      "end-time": "00:01:23,88"
    },
    {
      "speaker": "sip:2000@netsapiens",
      "comment": "I appreciate it very much. Thanks again for calling Acme Automotive.",
      "sentiment": "Positive",
      "start-time": "00:01:23,70",
      "end-time": "00:01:26,76"
    },
    {
      "speaker": "sip:+18589267933@192.81.237.20",
      "comment": "Alright. Thank you. Bye now.",
      "sentiment": "Neutral",
      "start-time": "00:01:27,46",
      "end-time": "00:01:29,48"
    },
    {
      "speaker": "sip:2000@netsapiens",
      "comment": "Thank you.",
      "sentiment": "Positive",
      "start-time": "00:01:28,40",
      "end-time": "00:01:29,14"
    }
  ],
  "call-intelligence-summary-status": "success",
  "call-intelligence-topics-all": [
    "part order",
    "taillight",
    "toyota 4 runner",
    "vehicle model"
  ],
  "errors": null,
  "last-modified-datetime": "2024-10-01T22:48:26+00:00"
}

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required