POST - Create call transcribe

 

Purpose

Use this API to convert call recording to text. This API transcribes a call based on the provided Log ID and other parameters.

 

Authorization

HeaderKey

Description

Authorization*

Zoho-oauthtoken<space><ACCESS_TOKEN>

Accept*

Set to application/json.

Request URL

Method: POST

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

Scope: ZohoVoice.call.CREATE

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

language_code*

String

Represents the language code used for transcription.

 

Possible values:

  • nl-NL = Dutch (NL)

  • en-AU = English (AU)

  • en-CA = English (CA)

  • en-IN = English (IN)

  • en-GB = English (UK)

  • en-US = English (US)

  • fr-CA = French (CA)

  • fr-FR = French (FR)

  • de-DE = German (DE)

  • hi-IN = Hindi (IN)

  • it-IT = Italian (IT)

  • ja-JP = Japanese (JP)

  • ko-KR = Korean (KR)

  • pt-BR = Portuguese (BR)

  • pt-PT = Portuguese (PT)

  • es-US = Spanish (US)

  • es-ES = Spanish (ES)

 

Example: en-US

 

transcriptionType

Number

Represents the transcription type.

 

Possible values:

  • 1 - Voicemail (default)

  • 2 - Call recording

     

Example: 2

isEmailNotificationEnabled

Boolean

Represents whether email notifications are enabled. Default value is false.



Example: false

providerId

Number

Represents the transcription provider.

 

Possible values:

  • 0 - Google (default)

  • 1 -  Zoho

 

Example:  1

canAttachFileInEmail

Boolean

Represents whether the transcription file can be attached in the email.

 

Example: false

canSendEmailToSupervisor

Boolean

Represents whether the transcription email can be sent to the supervisor.

 

Example: true

isTranscriptionTCAccepted

Boolean

Represents whether the transcription terms and conditions are accepted.

 

Example: true

Sample Request

Copiedurl "https://voice.zoho.com/rest/json/zv/api/agents/onlineStatus" \
-X GET \
-H "Authorization:Zoho-oauthtoken *****"
curl 'https://voice.zoho.com/rest/json/zv/transcribe' \
  -H 'Origin: https://voice.zoho.com' \
  -H 'Authorization:Zoho-oauthtoken *****' \
 --data-raw 'logId=b8446e9e-e285-4136-86ac-0e2e2f09299d&language_code=en-US&providerId=1&canAttachFileInEmail=false&isEmailNotificationEnabled=false&canSendEmailToSupervisor=false&transcriptionType=2&isTranscriptionTCAccepted=true'

Sample Response - Success

Copied{
 "code": "200",
 "message": "Call Recording transcription has been initiated, and it is expected to take approximately 44 seconds.",
 "status": "SUCCESS"
}

Sample Response - Error

Copied{
 "status": "ERROR",
 "code": "500",
 "message": "Transcription limit reached."
}