Real-Time Transcription Rejected

This event may be sent to the url specified when sending a <StartTranscription> verb. This event will be sent if the real-time transcription requested in the <StartTranscription> verb was not started.

Request Parameters

Property	Description
accountId	The user account associated with the call
answerTime	Time the call was answered, in ISO 8601 format
applicationId	The id of the application associated with the call
callId	The call id associated with the event
callUrl	The URL of the call associated with the event
cause	The reason the real-time transcription was rejected, can be one of connection-error, duplicate, error or track-limit
direction	The direction of the call. Either inbound or outbound. The direction of a call never changes.
enqueuedTime	(optional) If call queueing is enabled and this is an outbound call, this is the time the call was queued, in ISO 8601 format. Otherwise, this is omitted.
errorMessage	Detailed information about the cause
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.
eventType	The event type, value is realTimeTranscriptionRejected
from	The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) even if privacy is set to true.
privacy	(optional) Hide the calling number. The callerDisplayName field can be used to customize the displayed name.
callerDisplayName	(optional) The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If privacy is true, only the following values are valid: Restricted, Anonymous, Private, or Unavailable.
realTimeTranscription	Details about the rejected real-time transcription
realTimeTranscription.name	The name of the rejected real-time transcription
realTimeTranscription.startTime	The approximate UTC date and time the rejected real-time transcription was started
realTimeTranscription.id	The unique id of the rejected real-time transcription
realTimeTranscription.tracks	The segments of the call that were going to be sent in the rejected real-time transcription, values will be one or both of inbound and outbound
realTimeTranscription.destination	(optional) The destination URL to which the rejected real-time transcription was going to be sent
realTimeTranscription.stabilized	(optional) Whether transcription update events will be sent to the specified destination only after they have become stable.
originalTranscription	(optional) Details about the original real-time transcription if this rejection is due to requesting a duplicate name
originalTranscription.name	The name of the original real-time transcription
originalTranscription.id	The unique id of the original real-time transcription
originalTranscription.startTime	The approximate UTC date and time the original real-time transcription was started
originalTranscription.tracks	The segments of the call that are being sent in the original real-time transcription, values will be one or both of inbound and outbound
originalTranscription.destination	(optional) The destination URL to which the original real-time transcription is sending media
originalTranscription.stabilized	(optional) Whether transcription update events for the original transcription request will be sent to the specified destination only after they have become stable.
startTime	Time the call was started, in ISO 8601 format.
to	The phone number that received the call, in E.164 format (e.g. +15555555555).
tag	(optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.

Possible cause Values

Value	Meaning
connection-error	There was a problem communicating with the destination supplied in the [<StartTranscription>][2] request. For example connecting to the websocket timed out, or the websocket closed abnormally, etc.
duplicate	The real-time transcription was a duplicate of another existing real-time transcription
error	There was an internal error other than a problem communicating with the destination
track-limit	The requested real-time transcription exceeded the maximum number of tracks that may be transcribed on a single call

Expected Response

HTTP/1.1 204

Examples

Real-Time Transcription Rejected Event for Duplicate Name with Enqueued Time

POST http://myapp.example/realTimeTranscriptionEvents
Content-Type: application/json

{
  "accountId"          : "55555555",
  "answerTime"         : "2022-06-30T18:55:02.080Z",
  "applicationId"      : "7fc9698a-b04a-468b-9e8f-91238c0d0086",
  "callId"             : "c-95ac912f-68aacdd7-4a8e-4223-a7fd-020e02fa6bf2",
  "callUrl"            : "https://voice.bandwidth.com/api/v2/accounts/55555555/calls/c-95ac912f-68aacdd7-4a8e-4223-a7fd-020e02fa6bf2",
  "cause"              : "duplicate",
  "direction"          : "outbound",
  "enqueuedTime"       : "2022-06-30T18:54:59.172Z",
  "errorMessage"       : "A real-time transcription with the name example_real-time_transcription already exists",
  "eventTime"          : "2022-06-30T18:55:02.489Z",
  "eventType"          : "realTimeTranscriptionRejected",
  "from"               : "+15551112222",
  "transcription" : {
    "name"        : "example_real-time_transcription",
    "id"          : "s-95ac90b3-a2b4fd9b-579c-4cc7-898e-3d257c7a042b",
    "startTime"   : "2022-06-30T18:55:02.489Z",
    "tracks"      : ["outbound"]
  },
  "originalTranscription" : {
    "name"        : "example_real-time_transcription",
    "id"          : "t-95ac90b3-e9cd80fa-fca7-4d12-9109-2990afe4d8c5",
    "startTime"   : "2022-06-30T18:55:02.489Z",
    "tracks"      : ["inbound", "outbound"],
    "destination" : "wss://websocket.myapp.example",
    "stabilized"  : "false"
  },
  "startTime"          : "2022-06-30T18:54:59.175Z",
  "to"                 : "+15553334444"
}

Real-Time Transcription Rejected Event for Duplicate Name with Enqueued Time And Destination

POST http://myapp.example/realTimeTranscriptionEvents
Content-Type: application/json

{
  "accountId"          : "55555555",
  "answerTime"         : "2022-06-30T18:55:02.080Z",
  "applicationId"      : "7fc9698a-b04a-468b-9e8f-91238c0d0086",
  "callId"             : "c-95ac912f-68aacdd7-4a8e-4223-a7fd-020e02fa6bf2",
  "callUrl"            : "https://voice.bandwidth.com/api/v2/accounts/55555555/calls/c-95ac912f-68aacdd7-4a8e-4223-a7fd-020e02fa6bf2",
  "cause"              : "duplicate",
  "direction"          : "outbound",
  "enqueuedTime"       : "2022-06-30T18:54:59.172Z",
  "errorMessage"       : "A real-time transcription with the name example_real-time_transcription already exists",
  "eventTime"          : "2022-06-30T18:55:02.489Z",
  "eventType"          : "realTimeTranscriptionRejected",
  "from"               : "+15551112222",
  "transcription" : {
    "name"        : "example_real-time_transcription",
    "id"          : "t-95ac90b3-a2b4fd9b-579c-4cc7-898e-3d257c7a042b",
    "startTime"   : "2022-06-30T18:55:02.489Z",
    "tracks"      : ["outbound"],
    "destination" : "wss://duplicate.websocket.myapp.example",
    "stabilized"  : "true"
  },
  "originalTranscription" : {
    "name"        : "example_real-time_transcription",
    "id"          : "t-95ac90b3-e9cd80fa-fca7-4d12-9109-2990afe4d8c5",
    "startTime"   : "2022-06-30T18:55:02.489Z",
    "tracks"      : ["inbound", "outbound"],
    "destination" : "wss://websocket.myapp.example",
    "stabilized"  : "false"
  },
  "startTime"          : "2022-06-30T18:54:59.175Z",
  "to"                 : "+15553334444"
}