GET - Get transcription details

 

Purpose

Use this API to retrieve the transcription details of a call by providing the calllog ID and transcription type.

 

Authorization

HeaderKey

Description

Authorization*

Zoho-oauthtoken<space><ACCESS_TOKEN>

Accept*

Set to application/json.

Request URL

Method: GET

https://voice.zoho.com/rest/json/zv/transcribe

Scope: ZohoVoice.call.READ

Parameters: 

Param Name

Data Type

Description

logId*

String

Represents the unique identifier (ID) of the call for which transcription is performed.

 

Example: 7904492e-4afa-40f3-9fed-6ff665cb182e

transcriptionType*

Number

Represents the transcription type.

 

Possible values:

  • 1 - Voicemail (default)

  • 2 - Call recording

     

Example: 2

Sample Request

Copiedcurl "https://voice.zoho.com/rest/json/zv/transcribe?logId=3daa20e0-8822-4c2b-b70a-bd6e0e6f6b49&transcriptionType=2" \
-X GET \
-H "Authorization:Zoho-oauthtoken *****"

Sample Response - Success

Copied{
 "code": "200",
"transcribeObj": "{\"transcriptionProvider\":\"Zoho\",\"callAnalytics\":[{\"result\":\"Neutral\",\"feature\":\"sentiment\"},{\"result\":\"Happy\",\"feature\":\"emotion\"},{\"result\":\"Query\",\"feature\":\"intent\"},{\"result\":\"The customer, a relationship manager, calls the agent from Zoho and expresses their desire to speak. The agent confirms the time and location of the call. The customer agrees to call back after two hours. The agent expresses their appreciation for the customer's understanding.\",\"feature\":\"summary\"},{\"result\":[{\"highlights\":\"brother I'm I'm driving now yes, just after two hours\",\"reasoning\":[{\"tag\":\"Date\",\"content\":\"now\"}]},{\"highlights\":\"good time\",\"reasoning\":[{\"tag\":\"key-phrase\",\"content\":\"good time\"}]},{\"highlights\":\"relationship manager\",\"reasoning\":[{\"tag\":\"key-phrase\",\"content\":\"relationship manager\"}]},{\"highlights\":\"call\",\"reasoning\":[{\"tag\":\"key-phrase\",\"content\":\"call\"}]}],\"feature\":\"call_highlights\"},{\"result\":[{\"satisfaction_score\":0.82,\"poliness_score\":0.99,\"agent_score\":0.89}],\"feature\":\"call_score\"}],\"transcriptJson\":[{\"start_time\":1.08,\"transcript\":\"Hello\",\"speaker\":1,\"end_time\":1.32},{\"start_time\":3.7092,\"transcript\":\"Yeah hi hello\",\"speaker\":2,\"end_time\":5.6834},{\"start_time\":7.14,\"transcript\":\"yes,\",\"speaker\":1,\"end_time\":7.32},{\"start_time\":9.0934,\"transcript\":\"calling you from Zoho,\",\"speaker\":2,\"end_time\":10.29},{\"start_time\":12.18,\"transcript\":\"yeah,\",\"speaker\":1,\"end_time\":12.36},{\"start_time\":13.7,\"transcript\":\"I'm your relationship manager for yourself. Is this a good time to talk?\",\"speaker\":2,\"end_time\":18.26},{\"start_time\":19.8,\"transcript\":\"no brother I'm I'm driving now\",\"speaker\":1,\"end_time\":21.42},{\"start_time\":22.64,\"transcript\":\"Okay where do you want me to call you back sir?\",\"speaker\":2,\"end_time\":24.74},{\"start_time\":26.64,\"transcript\":\"yes, just after two hours please,\",\"speaker\":1,\"end_time\":28.38},{\"start_time\":29.5336,\"transcript\":\"Yeah, sure then I can give you a call back. Thank you.\",\"speaker\":2,\"end_time\":32.1533},{\"start_time\":32.5668,\"transcript\":\"Okay, thank you, thank you.\",\"speaker\":1,\"end_time\":33.5815}]}",
 "status": "SUCCESS"
}

Sample Response - Error

Copied{
    "code": "ZVTST005",
    "message": "Call log deleted or no permission",
    "status": "ERROR"
}