Get Call Transcriptions

curl --request GET \
  --url https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}/transcriptions \
  --header 'apikey: <api-key>'

import requests

url = "https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}/transcriptions"

headers = {"apikey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}/transcriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}/transcriptions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}/transcriptions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}/transcriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "roomName": "v1.us.{appId}.16923681138d75114d60d1345a22e4cc612263fb26c0b5cf92@conference.rtc.cometchat.io",
      "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
      "tid": "0f1f4d7a-6c3b-4a2e-9d15-8a7c2b4e6f10",
      "startTime": 1692368127,
      "endTime": 1692368146,
      "transcriptDate": "2023-08-18T14:15:27.000Z",
      "transcriptUrl": "https://transcripts.cometchat.io/31780434a95d45/transcript_2023-08-18T14:15:27.000Z_0f1f4d7a-6c3b-4a2e-9d15-8a7c2b4e6f10.json"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

GET

calls

{sessionId}

transcriptions

Get Call Transcriptions

curl --request GET \
  --url https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}/transcriptions \
  --header 'apikey: <api-key>'

import requests

url = "https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}/transcriptions"

headers = {"apikey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}/transcriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}/transcriptions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}/transcriptions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}/transcriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "roomName": "v1.us.{appId}.16923681138d75114d60d1345a22e4cc612263fb26c0b5cf92@conference.rtc.cometchat.io",
      "mid": "855e1519-1244-4213-8e40-53044c1e9e43",
      "tid": "0f1f4d7a-6c3b-4a2e-9d15-8a7c2b4e6f10",
      "startTime": 1692368127,
      "endTime": 1692368146,
      "transcriptDate": "2023-08-18T14:15:27.000Z",
      "transcriptUrl": "https://transcripts.cometchat.io/31780434a95d45/transcript_2023-08-18T14:15:27.000Z_0f1f4d7a-6c3b-4a2e-9d15-8a7c2b4e6f10.json"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Retrieve the transcriptions generated for a specific call using its session ID. Each entry describes one transcript file, including the window it covers and the URL to download it. The optional onBehalfOf header scopes the request to a specific user; leave it out to call as the app itself.

When to Use

Scenario	Description
Transcript playback	Fetch the transcript file URLs for a completed call
Compliance and archival	Export call transcripts into your own retention system
Long calls	Page through calls that produced more than the 5 transcripts embedded in the call object
Search and analytics	Feed transcript content into downstream indexing or summarization

Example Request

curl -X GET "https://{appId}.call-{region}.cometchat.io/v3/calls/v1.us.31780434a95d45.16923681138d75114d60d1345a22e4cc612263fb26c0b5cf92/transcriptions" \
  -H "apikey: YOUR_REST_API_KEY"

Response Details

Each entry in the data array describes one transcript file:

Property	Type	Description
`roomName`	string	The conference room the transcript belongs to
`mid`	string	Unique meeting identifier; absent when the transcript covers the whole session
`tid`	string	Unique transcript identifier
`startTime`	integer	UNIX timestamp when the transcribed segment started
`endTime`	integer	UNIX timestamp when the transcribed segment ended
`transcriptDate`	string	ISO 8601 timestamp of when the transcript was produced
`transcriptUrl`	string	URL to the transcript file

Transcriptions are generated asynchronously after a call ends, so a call that has just finished may return an empty data array. Fields with no value are omitted from the response rather than returned as null.

Pagination

Results are paginated, newest transcript first. Use page and perPage to page through them.

Parameter	Default	Maximum
`page`	1	—
`perPage`	100	1000

curl -X GET "https://{appId}.call-{region}.cometchat.io/v3/calls/{sessionId}/transcriptions?page=2&perPage=50" \
  -H "apikey: YOUR_REST_API_KEY"

Relationship to the Call Object

The List Calls and Get Call responses embed the 5 most recent transcriptions on each call whose hasTranscription is true. Use this endpoint when a call has more than 5 transcripts, or when you need to page through them.

Authorizations

apikey

string

header

required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Headers

onBehalfOf

string

UID of the user on whose behalf the action is performed.

Path Parameters

sessionId

string

required

Call whose transcriptions are to be retrieved

Query Parameters

page

integer

The page of results to return. Defaults to 1.

perPage

integer

The number of transcriptions to return per page. Defaults to 100, capped at 1000.

Response

200 - application/json

Retrieves Call Transcriptions

data

object[]

Show child attributes

​When to Use

​Example Request

​Response Details

​Pagination

​Relationship to the Call Object

Authorizations

Headers

Path Parameters

Query Parameters

Response

When to Use

Example Request

Response Details

Pagination

Relationship to the Call Object