Skip to main content

Transcription Available

The Transcription Available event is sent when the recording transcription is available to be downloaded.

Request Parameters#

PropertyDescription
eventTypeThe event type, value is transcriptionAvailable.
eventTimeThe approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution.
accountIdThe account id associated with the event.
applicationIdThe application id associated with the event.
callIdThe call id associated with the event.
parentCallId(optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present.
recordingIdThe unique id for this recording.
toThe phone number that received the call, in E.164 format (e.g. +15555555555).
fromThe provided identifier string of the caller used in the from field of the original call.
directionThe direction of the call. Either inbound or outbound. The direction of a call never changes.
tag(optional) The tag specified earlier in the call. If no tag was specified or it was previously cleared, this field will not be present.
enqueuedTime(optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
startTimeTime the recording started (in ISO8601 format).
endTimeTime the recording ended (in ISO8601 format).
durationLength of the recording (in ISO8601 format).
fileFormatThe format that the recording was saved in - mp3 or wav.
callUrlThe URL of the call associated with the event.
mediaUrlURL to retrieve the contents of the recording.
transcriptionTranscription information, see below.
transferCallerId(optional) If the event is related to the B leg of a <Transfer>, the phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). Otherwise, this field will not be present.
transferTo(optional) If the event is related to the B leg of a <Transfer>, the phone number used as the to field of the B-leg call in E.164 format (e.g. +15555555555). Otherwise, this field will not be present.

Expected Response#

HTTP/1.1 204

Examples#

Recording Available Event#

POST http://yourUrl.example/transcriptionAvailable
Content-Type: application/json
{
"eventType" : "transcriptionAvailable",
"eventTime" : "2019-09-13T16:53:34.229Z",
"accountId" : "55555555",
"callId" : "c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d",
"recordingId" : "r-115da407-e3d9-4ea7-889f-5f4ad7386a80",
"applicationId" : "7fc9698a-b04a-468b-9e8f-91238c0d0086",
"direction" : "outbound",
"from" : "+15551112222",
"to" : "+15553334444",
"startTime" : "2019-09-13T16:48:29.235Z",
"endTime" : "2019-09-13T16:48:48.890Z",
"duration" : "PT20.056S",
"fileFormat" : "wav",
"callUrl" : "https://../{accountId}/calls/{callId-1}",
"mediaUrl" : "https://../{accountId}/calls/{callId-1}/recordings/{recordingId}/media",
"transcription" : {
"id" : "t-1a68a908-544f-48ae-b30d-d1747dca3723",
"url" : "https://../{accountId}/calls/{callId-1}/recordings/{recordingId}/transcription",
"status" : "available",
"completedTime" : "2019-09-13T16:49:28.883Z"
}
}

Recording Available Event with Enqueued Time#

POST http://yourUrl.example/transcriptionAvailable
Content-Type: application/json
{
"eventType" : "transcriptionAvailable",
"eventTime" : "2019-09-13T16:53:34.229Z",
"accountId" : "55555555",
"callId" : "c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d",
"recordingId" : "r-115da407-e3d9-4ea7-889f-5f4ad7386a80",
"applicationId" : "7fc9698a-b04a-468b-9e8f-91238c0d0086",
"direction" : "outbound",
"from" : "+15551112222",
"to" : "+15553334444",
"enqueuedTime" : "2019-09-13T16:45:12.644Z",
"startTime" : "2019-09-13T16:48:29.235Z",
"endTime" : "2019-09-13T16:48:48.890Z",
"duration" : "PT20.056S",
"fileFormat" : "wav",
"callUrl" : "https://../{accountId}/calls/{callId-1}",
"mediaUrl" : "https://../{accountId}/calls/{callId-1}/recordings/{recordingId}/media",
"transcription" : {
"id" : "t-1a68a908-544f-48ae-b30d-d1747dca3723",
"url" : "https://../{accountId}/calls/{callId-1}/recordings/{recordingId}/transcription",
"status" : "available",
"completedTime" : "2019-09-13T16:49:28.883Z"
}
}