This API is used to control the transcription session of a bot conversation. It lets you end an ongoing transcription session by sending the appropriate action.

Method	POST
Endpoint	https://{{host}}/api/1.1/public/bot/{botid}/control/transcription?conversationId={conversationId}
Content Type	application/json
Authorization	auth: {{JWT}} See How to generate the JWT Token.
API Scope	AgentAssist Transcription

Path Parameters

Parameter	Required/Optional	Description
host	Required	Environment URL, for example, https://smartassist.kore.ai
botId	Required	Unique ID of the bot

Query Parameters

Parameter	Required/Optional	Description
conversationId	Required	Unique identifier of the bot conversation

Sample Request

For Start action

curl --location 'https://{{host}}/api/1.1/public/bot/st-4b8bb9d0-096d-56e5-b72f-f43ecf1xxxxx/control/transcription?conversationId=CAe8a34d2556235bcf0cbc51e98bbxxxxx' \
--header 'auth: {{JWT_TOKEN}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMiwiYXBwSWQiOiJjcy0zMWVhZD c5Zi0xNDhlLTVmZDUtOTdlNC1mZmI0ZmZjY2FhOTAifQ.b4eBlpjTEkywayWzmgXf-PeKC-6-suxxxxx' \
--data '{
    "action": "start",
    "agentId":"<Agent ID>"
}
'

For Pause action

curl --location 'https://{{host}}/api/1.1/public/bot/st-4b8bb9d0-096d-56e5-b72f-f43ecf1xxxxx/control/transcription?conversationId=CAe8a34d2556235bcf0cbc51e98bbxxxxx' \
--header 'auth: {{JWT_TOKEN}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMiwiYXBwSWQiOiJjcy0zMWVhZD c5Zi0xNDhlLTVmZDUtOTdlNC1mZmI0ZmZjY2FhOTAifQ.b4eBlpjTEkywayWzmgXf-PeKC-6-suxxxxx' \
--data '{
    "action": "pause",
    "agentId":"<Agent ID>",
    "handover": true
}
'

For Resume action

curl --location 'https://{{host}}/api/1.1/public/bot/st-4b8bb9d0-096d-56e5-b72f-f43ecf1xxxxx/control/transcription?conversationId=CAe8a34d2556235bcf0cbc51e98bbxxxxx' \
--header 'auth: {{JWT_TOKEN}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMiwiYXBwSWQiOiJjcy0zMWVhZD c5Zi0xNDhlLTVmZDUtOTdlNC1mZmI0ZmZjY2FhOTAifQ.b4eBlpjTEkywayWzmgXf-PeKC-6-suxxxxx' \
--data '{
    "action": "resume",
    "agentId":"<Agent ID>"
}
'

For End action

curl --location 'https://{{host}}/api/1.1/public/bot/st-4b8bb9d0-096d-56e5-b72f-f43ecf1xxxxx/control/transcription?conversationId=CAe8a34d2556235bcf0cbc51e98bbxxxxx' \
--header 'auth: {{JWT_TOKEN}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMiwiYXBwSWQiOiJjcy0zMWVhZD
c5Zi0xNDhlLTVmZDUtOTdlNC1mZmI0ZmZjY2FhOTAifQ.b4eBlpjTEkywayWzmgXf-PeKC-6-suxxxxx' \
--data '{
    "action": "end"
    "agentId":"<Agent ID>"
}
'

Body Parameters

Parameter	Description	Mandate
action	The control actions to be performed. 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.	Required
agentId	A string of agentId values.	Required
handover	Indicates whether a conversation has been transferred to another agent (used with the pause action). true – The agent transfers the call (e.g., cold transfer) and sends the “pause” event. false – A normal hold by the agent (e.g., for consultation).	Required

Sample Response

{
    "status": "success"
}