Replace a meeting
PUT/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}
Replaces all the details for the given meeting ID.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
Path Parameters
Body ParametersJSON
live_stream_on_start: optional boolean
Specifies if the meeting should start getting livestreamed on start.
persist_chat: optional boolean
If a meeting is set to persist_chat, meeting chat would remain for a week within the meeting space.
record_on_start: optional boolean
Specifies if the meeting should start getting recorded as soon as someone joins the meeting.
session_keep_alive_time_in_secs: optional number
Time in seconds, for which a session remains active, after the last participant has left the meeting.
maximum600
minimum60
Replace a meeting
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/realtime/kit/$APP_ID/meetings/$MEETING_ID \
-X PUT \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
-d '{}'{
"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
}
}