POST {{baseUrl}}/users/:userId/meetings
Create a meeting for a user. For user-level apps, pass the Note: For security reasons, the recommended way to programmatically get the updated 100 requests per day. The rate limit is applied against the Scopes: Rate Limit Label: me
value instead of the userId
parameter.
start_url
value is the URL a host or an alternative host can use to start a meeting. The expiration time for the start_url
value is two hours for all regular users.custCreate
meeting hosts (users created with the custCreate
parameter via the Create users API), the expiration time of the start_url
parameter is 90 days from the generation of the start_url
.start_url
value after expiry is to call the Get a meeting API. Refer to the start_url
value in the response. userId
of the meeting host used to make the request.meeting:write
,meeting:write:admin
MEDIUM
Body
PARAM
Key | Datatype | Required | Description |
HEADERS
Key | Datatype | Required | Description |
Content-Type
|
string | ||
Accept
|
string |
RESPONSES
status Created
{
"assistant_id": "<string>",
"host_email": "<email>",
"id": "<long>",
"registration_url": "<string>",
"agenda": "<string>",
"created_at": "<dateTime>",
"duration": "<integer>",
"h323_password": "<string>",
"join_url": "<string>",
"chat_join_url": "<string>",
"occurrences": [
{
"duration": "<integer>",
"occurrence_id": "<string>",
"start_time": "<dateTime>",
"status": "deleted"
},
{
"duration": "<integer>",
"occurrence_id": "<string>",
"start_time": "<dateTime>",
"status": "available"
}
],
"password": "<string>",
"pmi": "<string>",
"pre_schedule": false,
"recurrence": {
"type": 1,
"end_date_time": "<dateTime>",
"end_times": 1,
"monthly_day": 1,
"monthly_week": 4,
"monthly_week_day": 4,
"repeat_interval": "<integer>",
"weekly_days": "1"
},
"settings": {
"allow_multiple_devices": "<boolean>",
"alternative_hosts": "<string>",
"alternative_hosts_email_notification": true,
"alternative_host_update_polls": "<boolean>",
"approval_type": 2,
"approved_or_denied_countries_or_regions": {
"approved_list": [
"<string>",
"<string>"
],
"denied_list": [
"<string>",
"<string>"
],
"enable": "<boolean>",
"method": "deny"
},
"audio": "both",
"audio_conference_info": "<string>",
"authentication_domains": "<string>",
"authentication_exception": [
{
"email": "<email>",
"name": "<string>",
"join_url": "<string>"
},
{
"email": "<email>",
"name": "<string>",
"join_url": "<string>"
}
],
"authentication_name": "<string>",
"authentication_option": "<string>",
"auto_recording": "none",
"breakout_room": {
"enable": "<boolean>",
"rooms": [
{
"name": "<string>",
"participants": [
"<string>",
"<string>"
]
},
{
"name": "<string>",
"participants": [
"<string>",
"<string>"
]
}
]
},
"calendar_type": 1,
"close_registration": false,
"cn_meeting": false,
"contact_email": "<string>",
"contact_name": "<string>",
"custom_keys": [
{
"key": "<string>",
"value": "<string>"
},
{
"key": "<string>",
"value": "<string>"
}
],
"email_notification": true,
"encryption_type": "enhanced_encryption",
"enforce_login": "<boolean>",
"enforce_login_domains": "<string>",
"focus_mode": "<boolean>",
"global_dial_in_countries": [
"<string>",
"<string>"
],
"global_dial_in_numbers": [
{
"city": "<string>",
"country": "<string>",
"country_name": "<string>",
"number": "<string>",
"type": "tollfree"
},
{
"city": "<string>",
"country": "<string>",
"country_name": "<string>",
"number": "<string>",
"type": "toll"
}
],
"host_video": "<boolean>",
"in_meeting": false,
"jbh_time": 0,
"join_before_host": false,
"language_interpretation": {
"enable": "<boolean>",
"interpreters": [
{
"email": "<email>",
"languages": "<string>"
},
{
"email": "<email>",
"languages": "<string>"
}
]
},
"sign_language_interpretation": {
"enable": "<boolean>",
"interpreters": [
{
"email": "<email>",
"sign_language": "<string>"
},
{
"email": "<email>",
"sign_language": "<string>"
}
]
},
"meeting_authentication": "<boolean>",
"mute_upon_entry": false,
"participant_video": "<boolean>",
"private_meeting": "<boolean>",
"registrants_confirmation_email": "<boolean>",
"registrants_email_notification": "<boolean>",
"registration_type": 1,
"show_share_button": "<boolean>",
"use_pmi": false,
"waiting_room": false,
"watermark": false,
"host_save_video_order": "<boolean>",
"internal_meeting": false,
"continuous_meeting_chat": {
"enable": "<boolean>",
"auto_add_invited_external_users": "<boolean>",
"channel_id": "<string>"
},
"participant_focused_meeting": false,
"push_change_to_calendar": false,
"resources": [
{
"resource_type": "whiteboard",
"resource_id": "<string>",
"permission_level": "editor"
},
{
"resource_type": "whiteboard",
"resource_id": "<string>",
"permission_level": "editor"
}
],
"auto_start_meeting_summary": false,
"auto_start_ai_companion_questions": false
},
"start_time": "<dateTime>",
"start_url": "<string>",
"timezone": "<string>",
"topic": "<string>",
"tracking_fields": [
{
"field": "<string>",
"value": "<string>",
"visible": "<boolean>"
},
{
"field": "<string>",
"value": "<string>",
"visible": "<boolean>"
}
],
"type": 2
} |
ENDPOINTS