Update a meeting
Updates a meeting in an App for the given meeting ID.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYYAccepted Permissions (at least one required)
Realtime AdminRealtimeParametersExpand Collapse
params MeetingUpdateMeetingByIDParams
Body param: The AI Config allows you to customize the behavior of meeting transcriptions and summaries
Body param: The AI Config allows you to customize the behavior of meeting transcriptions and summaries
Summarization MeetingUpdateMeetingByIDParamsAIConfigSummarizationOptionalSummary Config
Summary Config
SummaryType MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeOptionalDefines the style of the summary, such as general, team meeting, or sales call.
Defines the style of the summary, such as general, team meeting, or sales call.
TextFormat MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormatOptionalDetermines the text format of the summary, such as plain text or markdown.
Determines the text format of the summary, such as plain text or markdown.
Transcription MeetingUpdateMeetingByIDParamsAIConfigTranscriptionOptionalTranscription Configurations
Transcription Configurations
Language MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageOptionalSpecifies the language code for transcription to ensure accurate results.
Specifies the language code for transcription to ensure accurate results.
Body param: Specifies if the meeting should start getting livestreamed on start.
Body param: If a meeting is updated to persist_chat, meeting chat would remain for a week within the meeting space.
Body param: Specifies if the meeting should start getting recorded as soon as someone joins the meeting.
Body param: Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
Body param: Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
AudioConfig MeetingUpdateMeetingByIDParamsRecordingConfigAudioConfigOptionalObject containing configuration regarding the audio that is being recorded.
Object containing configuration regarding the audio that is being recorded.
Channel MeetingUpdateMeetingByIDParamsRecordingConfigAudioConfigChannelOptionalAudio signal pathway within an audio file that carries a specific sound source.
Audio signal pathway within an audio file that carries a specific sound source.
Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours.
RealtimekitBucketConfig MeetingUpdateMeetingByIDParamsRecordingConfigRealtimekitBucketConfigOptional
StorageConfig MeetingUpdateMeetingByIDParamsRecordingConfigStorageConfigOptional
type MeetingUpdateMeetingByIDParamsRecordingConfigStorageConfigObject struct{…}
Access key of the storage medium. Access key is not required for the gcs storage media type.
Note that this field is not readable by clients, only writeable.
AuthMethod MeetingUpdateMeetingByIDParamsRecordingConfigStorageConfigObjectAuthMethodOptionalAuthentication method used for “sftp” type storage medium
Authentication method used for “sftp” type storage medium
SSH destination server password for SFTP type storage medium when auth_method is “PASSWORD”. If auth_method is “KEY”, this specifies the password for the ssh private key.
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
type MeetingUpdateMeetingByIDParamsRecordingConfigStorageConfigObject struct{…}
AuthMethod MeetingUpdateMeetingByIDParamsRecordingConfigStorageConfigObjectAuthMethodOptionalAuthentication method used for “sftp” type storage medium
Authentication method used for “sftp” type storage medium
SSH destination server password for SFTP type storage medium when auth_method is “PASSWORD”. If auth_method is “KEY”, this specifies the password for the ssh private key.
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Type MeetingUpdateMeetingByIDParamsRecordingConfigStorageConfigObjectTypeOptional
type MeetingUpdateMeetingByIDParamsRecordingConfigStorageConfigObject struct{…}
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
Access key of the storage medium. Access key is not required for the gcs storage media type.
Note that this field is not readable by clients, only writeable.
SSH destination server password for SFTP type storage medium when auth_method is “PASSWORD”. If auth_method is “KEY”, this specifies the password for the ssh private key.
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Type MeetingUpdateMeetingByIDParamsRecordingConfigStorageConfigObjectTypeOptionalType of storage media.
Type of storage media.
type MeetingUpdateMeetingByIDParamsRecordingConfigStorageConfigObject struct{…}
SSH destination server password for SFTP type storage medium when auth_method is “PASSWORD”. If auth_method is “KEY”, this specifies the password for the ssh private key.
Access key of the storage medium. Access key is not required for the gcs storage media type.
Note that this field is not readable by clients, only writeable.
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Type MeetingUpdateMeetingByIDParamsRecordingConfigStorageConfigObjectTypeOptionalType of storage media.
Type of storage media.
VideoConfig MeetingUpdateMeetingByIDParamsRecordingConfigVideoConfigOptional
Codec MeetingUpdateMeetingByIDParamsRecordingConfigVideoConfigCodecOptionalCodec using which the recording will be encoded.
Codec using which the recording will be encoded.
Watermark MeetingUpdateMeetingByIDParamsRecordingConfigVideoConfigWatermarkOptionalWatermark to be added to the recording
Watermark to be added to the recording
Position MeetingUpdateMeetingByIDParamsRecordingConfigVideoConfigWatermarkPositionOptionalPosition of the watermark
Position of the watermark
Body param: Time in seconds, for which a session remains active, after the last participant has left the meeting.
Body param: Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
Body param: Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
ReturnsExpand Collapse
type MeetingUpdateMeetingByIDResponse struct{…}
Data MeetingUpdateMeetingByIDResponseDataOptionalData returned by the operation
Data returned by the operation
Timestamp the object was created at. The time is returned in ISO format.
Timestamp the object was updated at. The time is returned in ISO format.
AIConfig MeetingUpdateMeetingByIDResponseDataAIConfigOptionalThe AI Config allows you to customize the behavior of meeting transcriptions and summaries
The AI Config allows you to customize the behavior of meeting transcriptions and summaries
Summarization MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationOptionalSummary Config
Summary Config
SummaryType MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeOptionalDefines the style of the summary, such as general, team meeting, or sales call.
Defines the style of the summary, such as general, team meeting, or sales call.
TextFormat MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormatOptionalDetermines the text format of the summary, such as plain text or markdown.
Determines the text format of the summary, such as plain text or markdown.
Transcription MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionOptionalTranscription Configurations
Transcription Configurations
Language MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageOptionalSpecifies the language code for transcription to ensure accurate results.
Specifies the language code for transcription to ensure accurate results.
Specifies if the meeting should start getting recorded as soon as someone joins the meeting.
RecordingConfig MeetingUpdateMeetingByIDResponseDataRecordingConfigOptionalRecording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
AudioConfig MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigOptionalObject containing configuration regarding the audio that is being recorded.
Object containing configuration regarding the audio that is being recorded.
Channel MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannelOptionalAudio signal pathway within an audio file that carries a specific sound source.
Audio signal pathway within an audio file that carries a specific sound source.
Codec MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodecOptionalCodec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.
Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.
Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours.
RealtimekitBucketConfig MeetingUpdateMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfigOptional
StorageConfig MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigOptional
type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigObject struct{…}
Access key of the storage medium. Access key is not required for the gcs storage media type.
Note that this field is not readable by clients, only writeable.
AuthMethod MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigObjectAuthMethodOptionalAuthentication method used for “sftp” type storage medium
Authentication method used for “sftp” type storage medium
SSH destination server password for SFTP type storage medium when auth_method is “PASSWORD”. If auth_method is “KEY”, this specifies the password for the ssh private key.
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigObject struct{…}
AuthMethod MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigObjectAuthMethodOptionalAuthentication method used for “sftp” type storage medium
Authentication method used for “sftp” type storage medium
SSH destination server password for SFTP type storage medium when auth_method is “PASSWORD”. If auth_method is “KEY”, this specifies the password for the ssh private key.
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigObjectTypeOptional
type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigObject struct{…}
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
Access key of the storage medium. Access key is not required for the gcs storage media type.
Note that this field is not readable by clients, only writeable.
SSH destination server password for SFTP type storage medium when auth_method is “PASSWORD”. If auth_method is “KEY”, this specifies the password for the ssh private key.
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigObjectTypeOptionalType of storage media.
Type of storage media.
type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigObject struct{…}
SSH destination server password for SFTP type storage medium when auth_method is “PASSWORD”. If auth_method is “KEY”, this specifies the password for the ssh private key.
Access key of the storage medium. Access key is not required for the gcs storage media type.
Note that this field is not readable by clients, only writeable.
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigObjectTypeOptionalType of storage media.
Type of storage media.
VideoConfig MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigOptional
Codec MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodecOptionalCodec using which the recording will be encoded.
Codec using which the recording will be encoded.
Watermark MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkOptionalWatermark to be added to the recording
Watermark to be added to the recording
Position MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionOptionalPosition of the watermark
Position of the watermark
Time in seconds, for which a session remains active, after the last participant has left the meeting.
Status MeetingUpdateMeetingByIDResponseDataStatusOptionalWhether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
Update a meeting
package main
import (
"context"
"fmt"
"github.com/cloudflare/cloudflare-go"
"github.com/cloudflare/cloudflare-go/option"
"github.com/cloudflare/cloudflare-go/realtime_kit"
)
func main() {
client := cloudflare.NewClient(
option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
)
response, err := client.RealtimeKit.Meetings.UpdateMeetingByID(
context.TODO(),
"app_id",
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
realtime_kit.MeetingUpdateMeetingByIDParams{
AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Success)
}
{
"success": true,
"data": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"created_at": "2019-12-27T18:11:19.117Z",
"updated_at": "2019-12-27T18:11:19.117Z",
"ai_config": {
"summarization": {
"summary_type": "general",
"text_format": "plain_text",
"word_limit": 150
},
"transcription": {
"keywords": [
"string"
],
"language": "en-US",
"profanity_filter": true
}
},
"live_stream_on_start": true,
"persist_chat": true,
"record_on_start": true,
"recording_config": {
"audio_config": {
"channel": "mono",
"codec": "MP3",
"export_file": true
},
"file_name_prefix": "file_name_prefix",
"live_streaming_config": {
"rtmp_url": "rtmp://a.rtmp.youtube.com/live2"
},
"max_seconds": 60,
"realtimekit_bucket_config": {
"enabled": true
},
"storage_config": {
"auth_method": "KEY",
"bucket": "bucket",
"host": "host",
"path": "path",
"port": 0,
"region": "us-east-1",
"type": "gcs",
"username": "username"
},
"video_config": {
"codec": "H264",
"export_file": true,
"height": 720,
"watermark": {
"position": "left top",
"size": {
"height": 1,
"width": 1
},
"url": "https://example.com"
},
"width": 1280
}
},
"session_keep_alive_time_in_secs": 60,
"status": "ACTIVE",
"summarize_on_end": true,
"title": "title",
"transcribe_on_end": true
}
}Returns Examples
{
"success": true,
"data": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"created_at": "2019-12-27T18:11:19.117Z",
"updated_at": "2019-12-27T18:11:19.117Z",
"ai_config": {
"summarization": {
"summary_type": "general",
"text_format": "plain_text",
"word_limit": 150
},
"transcription": {
"keywords": [
"string"
],
"language": "en-US",
"profanity_filter": true
}
},
"live_stream_on_start": true,
"persist_chat": true,
"record_on_start": true,
"recording_config": {
"audio_config": {
"channel": "mono",
"codec": "MP3",
"export_file": true
},
"file_name_prefix": "file_name_prefix",
"live_streaming_config": {
"rtmp_url": "rtmp://a.rtmp.youtube.com/live2"
},
"max_seconds": 60,
"realtimekit_bucket_config": {
"enabled": true
},
"storage_config": {
"auth_method": "KEY",
"bucket": "bucket",
"host": "host",
"path": "path",
"port": 0,
"region": "us-east-1",
"type": "gcs",
"username": "username"
},
"video_config": {
"codec": "H264",
"export_file": true,
"height": 720,
"watermark": {
"position": "left top",
"size": {
"height": 1,
"width": 1
},
"url": "https://example.com"
},
"width": 1280
}
},
"session_keep_alive_time_in_secs": 60,
"status": "ACTIVE",
"summarize_on_end": true,
"title": "title",
"transcribe_on_end": true
}
}