Skip to content

Control Transcription API v2

This API controls transcription and call recording sessions for Agent AI SIP-REC calls on third-party agent desktops during user-agent interactions. It lets you start, pause, resume, end/stop transcription and call recordings for a specific conversation by sending the appropriate action.

Method POST
Endpoint https://{{host}}/api/1.1/public/bot/{botid}/control/transcriptionv2?conversationId={conversationId}
Content Type application/json
Authorization auth: {{JWT}}

See How to generate the JWT Token

API Scope Agent AI Transcription and Call Recording

Path Parameters

Parameter Required/Optional Description
botId Required Unique identifier of the bot controlling the transcription and call recording.

Query Parameters

Parameter Required/Optional Description
conversationId Required Unique identifier of the conversation for which transcription and call recording is controlled.

Sample Request

curl --location 'https://staging-xo.korebots.com/api/1.1/public/bot/st-0510047e-9e82-5574-9523-bb02a0dxxxxx/control/transcriptionv2?conversationId=CAa8c6351c14ab45f09aaa04cde25xxxxx' 
--header 'auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6ImNzLWM5OGVlOTk2LTNhZGQtNTM2ZS04ODZhLTM2ZDEyODY0MTRjOCJ9.klXB766H8VXnXRKDFSpQJqfNN0mV254AKnABg4xxxxx' 
--header 'Content-Type: application/json' 
--data '{
    "transcription_action" : "resume",
    "recording_action" : "stop"
}'

Body Parameters

Parameter Required/Optional Description
transcription_action Optional The control actions to perform on transcription. Available actions:

start – Start the transcription session.

pause– Pause the transcription session.

resume – Resume the transcription session after a pause.

end – Terminate the transcription session.

recording_action Optional The control actions to perform on call recording.

Available actions:

start – Start the recording session.

pause– Pause the recording session.

resume – Resume the recording session after a pause.

stop – Terminate the recording session.

Note

The Record the calls button is configured at the Agent AI > Flows & Channels > Voice Gateway > SIP Numbers settings level. However, even if it is disabled there, this API can independently start and control the recordings.

Sample Response

{
    "status": "success"
}