List call transcriptions
Retrieves your team's call transcriptions with optional filters (date range, duration, pagination).
Permission: This endpoint is not governed by API token permissions. Your team must have the transcription feature enabled in its plan.
Monitoring: No impact.
For each transcription, in the items of the array of the <em>transcription_data.speeches</em> field, the field <em>channelId</em> takes one of the following values:
- <em>1</em> for the caller emitting the call
- <em>0</em> for the callee receiving the call
If the call is received by a Ringover user while the call is emitted by a call member that is not a registered contact, the <em>contact</em> field will be <em>null</em>.
The maximum rows returned has to be set in the parameter <em>limit_count</em> (limited to 100 rows). All the parameters are optional. The full text of each transcription is fetched per row, so larger pages would time out: paginate through your transcriptions with limit_offset in pages of up to 100. A limit_count above 100 is rejected with a 422.
Search mode: When the search query parameter is provided, a semantic vector search is run on transcription content. In this mode the filters audio_duration_from, audio_duration_to, created_from, created_to and limit_offset are ignored, and only limit_count is honored (it caps the number of matches returned, up to 100).
Query parameters
Maximum number of results to return per page (max 100). Default: 100.
The amount of transcriptions ignored, not returned
Free-text search query on transcription content. When provided (and the transcription feature is enabled for the team), results are returned by semantic relevance and the filters audio_duration_from, audio_duration_to, created_from, created_to and limit_offset are ignored. Only limit_count is honored (it caps the number of matches).
Used to filter out calls under a certain duration. The filter applies to the total duration of the call, not to the duration of the recording.
Used to filter out calls over a certain duration. The filter applies to the total duration of the call, not to the duration of the recording.
Return calls created after or at this date. The value must be in UTC and follow ISO 8601 / RFC 3339 format (e.g. YYYY-MM-DDTHH:MM:SSZ).
Return calls created before or at this date. The value must be in UTC and follow ISO 8601 / RFC 3339 format (e.g. YYYY-MM-DDTHH:MM:SSZ).
Response
Successful operation — returns the list of transcriptions matching your filters.
Example response
[
{
"id": 88,
"team_id": 16804,
"user_id": 50907,
"cdr_id": 991367,
"call_id": "11322631031026875934",
"channel_id": "17857850318647956376",
"provider": "SPEECH_CALLITY",
"user": {
"user_id": 123456,
"team_id": 123456,
"initial": "PM",
"color": "3CC8C8",
"firstname": "Pauline",
"lastname": "Martin",
"company": "Ringover",
"email": "pauline.martin@ringover.com",
"picture": "https://cdn77.ringover.com/img/users/default.jpg",
"concat_name": "Pauline Martin"
},
"contact": {
"contact_id": 654321,
"is_shared": true,
"social_service_id": "00P7U000015Ei75YBX",
"firstname": "John",
"lastname": "Do",
"company": "DoeCompany",
"concat_name": "John Doe",
"color": "3CC8C8",
"initial": "JD",
"creation_date": "2018-08-12T12:12:40.53Z",
"numbers": [
331797500010
]
},
"transcription_status": "DONE",
"creation_date": "2018-06-12T23:23:40.99Z"
}
]