Service enfonica.voice.v1beta1.Recordings¶
Methods¶
| DeleteRecording |
|---|
| rpc DeleteRecording(DeleteRecordingRequest) returns (Recording) Deletes a recording. The caller must have voice.recordings.delete permission on the project. |
| GetRecording |
|---|
| rpc GetRecording(GetRecordingRequest) returns (Recording) Retrieves a Recording identified by the supplied resource name. The caller must have voice.recordings.get permission on the project. |
| ListRecordings |
|---|
| rpc ListRecordings(ListRecordingsRequest) returns (ListRecordingsResponse) Lists the Recordings of the specified project. List returns Recordings sorted by create_time descending. The caller must have voice.recordings.list permission on the project. |
Resource: Recording¶
The Recording resource. This represents a recording, which can either be a recording of a small section of the call (eg recorded using the
| Fields | |
|---|---|
| name | string Resource name of the recording. It must match the pattern projects/*/calls/*/recordings/*. The call will always refer to the parent leg of a two-leg call. |
| state | State Output only. The state of the recording. |
| source | Source The source of the recording. This lets you know what triggered the recording to begin. This cannot be set by users. |
| duration | google.protobuf.Duration Output only. The duration of the recording, after any post processing. This is only set when the state is SUCCEEDED. |
| channel_count | int32 Output only. The number of channels that have been recorded. |
| post_processing[] | PostProcessing The post processing that should be applied to the recording. |
| error_code | ErrorCode Output only. When state is FAILED, an error code describing the type of error that occurred. |
| audio[] | RecordingAudio Output only. The audio that was recorded in various formats and encodings. For non-empty, successful recordings, there should always be an audio/x-wav and audio/mpeg recording. |
| start_time | google.protobuf.Timestamp Output only. The start time of the recording. This is when recording on the call started. Only set when state is SUCCEEDED. |
| create_time | google.protobuf.Timestamp Output only. The creation time of the recording. This is the time that the recording resource was created. This is usually immediately before start_time, but can be afterwards if processing was delayed. Output only. |
| ready_uri | string The URI to send the recording ready webhook to when the state transitions to a terminal state (SUCCEEDED, EMPTY, FAILED). Must be an absolute URI. |
PostProcessing¶
Post processing options.
| Enums | |
|---|---|
| POST_PROCESSING_UNSPECIFIED | Unspecified post processing. |
| TRIM_SILENCE | Trim silence from the start and end of the audio. |
Recording.ErrorCode¶
Error code definitions.
| Enums | |
|---|---|
| ERROR_CODE_UNSPECIFIED | Unspecified error code. |
| TIMEOUT | A timeout occurred, where a pending recording did not complete within the expected timeframe. |
| INTERNAL_ERROR | An internal error occurred while processing the recording. |
Recording.Source¶
The source of the recording. It is anticipated that additional values will be added in the future.
| Enums | |
|---|---|
| SOURCE_UNSPECIFIED | Unspecified recording source. |
| RECORD_ACTION | The recording was created by the <Record> action. |
| CALL_RECORDING | The recording was created by call recording. |
Recording.State¶
The state of the recording.
| Enums | |
|---|---|
| STATE_UNSPECIFIED | Unspecified state. |
| PENDING | The audio is currently being recorded, or recording has finished and the audio is pending processing. |
| SUCCEEDED | The audio has successfully been recorded. |
| EMPTY | The audio that was recorded was completely silent. |
| FAILED | The audio failed to be recorded due to a system error. For more information, see the value of error_code. |
RecordingAudio¶
Audio that is associated with a recording.
| Fields | |
|---|---|
| mime_type | string The MIME type of the audio file. This will likely be "audio/x-wav" or "audio/mpeg". |
| encoding | AudioEncoding The encoding of the audio. |
| sample_rate | int32 The sample rate of the audio. This will likely be 8000. |
| size_bytes | int32 The size of the audio in bytes. |
| uri | string An ephemeral URI that can be used to download the recording. The URI is valid for 60 minutes. Note that this field is only included in the FULL view. |
RecordingAudio.AudioEncoding¶
The audio encoding used. It is anticipated that additional values will be added in the future.
| Enums | |
|---|---|
| AUDIO_ENCODING_UNSPECIFIED | Unspecified audio encoding. |
| AUDIO_ENCODING_PCM_16BIT | PCM 16 bit per sample. |
| AUDIO_ENCODING_MP3 | MP3 compressed. |
GetRecordingRequest¶
The GetRecording request recording.
| Fields | |
|---|---|
| name | string Required. The resource name of the Recording to retrieve. Must be of the form projects/*/calls/*/recordings/*. |
| view | RecordingView Configuration of partial responses. Defaults to FULL. |
RecordingView¶
Configuration of partial responses for the Recording resource.
| Enums | |
|---|---|
| RECORDING_VIEW_UNSPECIFIED | The default / unset value. The API will default to BASIC for ListRecordings and FULL for GetRecording. |
| BASIC | Includes all fields except [RecordingAudio.uri][enfonica.voice.v1beta1.RecordingAudio.uri]. This is the default for ListRecordings. |
| FULL | Includes all fields. This is the default for GetRecording. |
ListRecordingsRequest¶
The ListRecordings request recording.
| Fields | |
|---|---|
| parent | string Required. The resource name of the parent of which to list recordings. May be of the form projects/*/calls/* to list the recordings of that specific call, or projects/* to list recordings across the entire project, which maps to projects/*/calls/-. |
| page_size | int32 The maximum number of Recordings to return in the response. Default value of 10 and maximum value of 100. |
| page_token | string A pagination token returned from a previous recording to ListRecordings that indicates where this listing should continue from. |
| view | RecordingView Configuration of partial responses. Defaults to BASIC. |
ListRecordingsResponse¶
The ListRecordings response recording.
| Fields | |
|---|---|
| recordings[] | Recording A possibly paginated list of Recordings that are direct descendants of the specified parent resource. |
| next_page_token | string A pagination token returned from a previous recording to ListRecordings that indicates from where listing should continue. |
DeleteRecordingRequest¶
The DeleteRecording request message.
| Fields | |
|---|---|
| name | string Required. The resource name of the Recording to be deleted. Must be of the form projects/*/calls/*/recording/*. |