Transcription Available event

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

Expected response

HTTP/1.1 204

Properties

Property Description
eventType The event type, value is transcriptionAvailable.
eventTime The 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.
accountId The account id associated with the event.
applicationId The application id associated with the event.
callId The 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.
recordingId The unique id for this recording.
to The phone number that received the call, in E.164 format (e.g. +15555555555).
from The provided identifier string of the caller used in the from field of the original call.
direction The 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.
startTime Time the recording started (in ISO8601 format).
endTime Time the recording ended (in ISO8601 format).
duration Length of the recording (in ISO8601 format).
fileFormat The format that the recording was saved in - mp3 or wav.
callUrl The URL of the call associated with the event.
mediaUrl URL to retrieve the contents of the recording.
transcription Transcription 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.

Transcription Properties

Property Description
id The unique id of the transcription.
url URL to retrieve the transcription output.
status The state of the transcription. Can be available, error, timeout, file-size-too-big, file-size-too-small.
completedTime Time the transcription was completed (in ISO8601 format).

Example: Recording Available event

POST http://[External server URL]

{
    "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"
    }
}

results matching ""

    No results matching ""