v10 -> v11
Call Transcription Model
- v10
- v11
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| detectedLanguage | DetectedLanguageEnum | The detected language for this transcription. | [optional] |
| track | TrackEnum | Which track this transcription is derived from. | [optional] |
| transcript | String | The transcription itself. | [optional] |
| confidence | Double | How confident the transcription engine was in transcribing the associated audio (from 0 to 1). | [optional] |
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| detectedLanguage | CallTranscriptionDetectedLanguageEnum | The detected language for this transcription. | [optional] |
| track | CallTranscriptionTrackEnum | Which track this transcription is derived from. | [optional] |
| transcript | String | The transcription itself. | [optional] |
| confidence | Double | How confident the transcription engine was in transcribing the associated audio (from 0 to 1). | [optional] |
CallTranscriptionDetectedLanguageEnum
EN_US(value:"en-US")ES_US(value:"es-US")FR_FR(value:"fr-FR")
CallTranscriptionTrackEnum
INBOUND(value:"inbound")OUTBOUND(value:"outbound")
Call Recording Metadata Model
- v10
- v11
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| applicationId | String | The id of the application associated with the call. | [optional] |
| accountId | String | The user account associated with the call. | [optional] |
| callId | String | The call id associated with the event. | [optional] |
| parentCallId | String | (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. | [optional] |
| recordingId | String | The unique ID of this recording | [optional] |
| to | String | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
| from | String | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
| transferCallerId | String | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
| transferTo | String | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
| duration | String | The duration of the recording in ISO-8601 format | [optional] |
| direction | CallDirectionEnum | [optional] | |
| channels | Integer | Always 1 for conference recordings; multi-channel recordings are not supported on conferences. | [optional] |
| startTime | OffsetDateTime | Time the call was started, in ISO 8601 format. | [optional] |
| endTime | OffsetDateTime | The time that the recording ended in ISO-8601 format | [optional] |
| fileFormat | FileFormatEnum | [optional] | |
| status | String | The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] |
| mediaUrl | URI | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] |
| transcription | RecordingTranscriptionMetadata | [optional] |
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| applicationId | String | The id of the application associated with the call. | [optional] |
| accountId | String | The user account associated with the call. | [optional] |
| callId | String | The call id associated with the event. | [optional] |
| parentCallId | String | (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. | [optional] |
| recordingId | String | The unique ID of this recording | [optional] |
| to | String | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
| from | String | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
| transferCallerId | String | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
| transferTo | String | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
| duration | String | The duration of the recording in ISO-8601 format | [optional] |
| direction | CallDirectionEnum | [optional] | |
| channels | Integer | Always 1 for conference recordings; multi-channel recordings are not supported on conferences. | [optional] |
| startTime | OffsetDateTime | Time the call was started, in ISO 8601 format. | [optional] |
| endTime | OffsetDateTime | The time that the recording ended in ISO-8601 format | [optional] |
| fileFormat | FileFormatEnum | [optional] | |
| status | String | The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] |
| mediaUrl | URI | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] |
| transcription | RecordingTranscriptionMetadata | [optional] | |
| recordingName | String | A name to identify this recording. | [optional] |