Method: createConferenceWithBots.create
Stay organized with collections
Save and categorize content based on your preferences.
Creates a conference and adds bots.
The video resolution requested by the bots mimics the resolution that would be requested by a Meet client using the "Auto" layout. See https://support.google.com/meethardware/answer/9295022.
- if numOfBots == 1: bots will request HD (1280x720) from the active speaker.
- if numOfBots < 6: bots will request VGA (640x360) from all participants.
- if numOfBots < 16: bots will request HVGA (480x270) from all participants.
- otherwise: bots will request HQVGA (240x135) from all participants.
HTTP request
POST https://botsondemand.googleapis.com/v1/createConferenceWithBots
The URL uses gRPC Transcoding syntax.
Request body
The request body contains data with the following structure:
| JSON representation |
{
"numOfBots": integer,
"ttlSecs": integer,
"defaultBotOptions": {
object (BotOptions)
},
"perBotOptions": [
{
object (BotOptions)
}
]
} |
| Fields |
numOfBots |
integer
Required. The number of bots to add, must be between 1 - 50.
|
ttlSecs |
integer
Required. TTL in seconds for the bots to stay in the meeting.
|
defaultBotOptions |
object (BotOptions)
Optional. Default options for all bots created as part of this request.
|
perBotOptions[] |
object (BotOptions)
Optional. Per bot options for bots created as part of this request. If fewer options are provided than the number of bots, the default options will be used for the remaining bots.
|
Response body
Response for {@link CreateConferenceWithBotsRequest}
If successful, the response body contains data with the following structure:
| JSON representation |
{
"conferenceCode": string,
"errorMessages": [
string
]
} |
| Fields |
conferenceCode |
string
The created conference.
|
errorMessages[] |
string
The error messages returned by the failed bots.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/meetings
For more information, see the OAuth 2.0 Overview.
BotOptions
Options specific to individual bots
| Fields |
requestedResolution |
enum (SupportedVideoResolutions)
Optional. Incoming resolution requested by the bots.
|
muteAudio |
boolean
Optional. Mute audio sent from bot, default False
|
muteVideo |
boolean
Optional. Mute video sent from bot, default False
|
playbackVideo |
enum (VideoFile)
Optional. The video file the bot should play
|
outputResolution |
enum (SupportedVideoResolutions)
Optional. Outgoing video resolution sent by the bots, the will select a playback video matching this resolution. This is only used if playbackVideo is not set.
|
SupportedVideoResolutions
Supported video resolutions presets
| Enums |
SUPPORTED_VIDEO_RESOLUTIONS_UNSPECIFIED |
Resolution unspecified |
THUMBNAIL_160_120 |
Thumbnail resolution |
QVGA_320_180 |
QVGA resolution at 16:9 ratio |
HVGA_480_270 |
HVGA resolution at 16:9 ratio |
VGA_640_360 |
VGA resolution at 16:9 ratio |
HD_1280_720 |
HD resolution at 16:9 ratio |
FHD_1920_1080 |
FHD resolution at 16:9 ratio |
VideoFile
Supported playback videos for external partners
| Enums |
VIDEO_FILE_UNSPECIFIED |
File unspecified |
SINGLE_ATTENDEE_IDLE_1 |
Single meeting attendee sitting idle |
SINGLE_ATTENDEE_CLAPPING_1 |
Single meeting attendee clapping |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-12 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-08-12 UTC."],[[["\u003cp\u003eCreates a Google Meet conference and populates it with a specified number of bots (1-50).\u003c/p\u003e\n"],["\u003cp\u003eBots can be customized with options like video resolution, audio/video muting, and video playback.\u003c/p\u003e\n"],["\u003cp\u003eThe API request requires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/meetings\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful responses provide the conference code and any error messages encountered during bot creation.\u003c/p\u003e\n"],["\u003cp\u003eBot video resolution automatically adjusts based on the total number of bots in the meeting, similar to a human participant using "Auto" layout in Google Meet.\u003c/p\u003e\n"]]],[],null,["# Method: createConferenceWithBots.create\n\nCreates a conference and adds bots.\n\nThe video resolution requested by the bots mimics the resolution that would be requested by a Meet client using the \"Auto\" layout. See \u003chttps://support.google.com/meethardware/answer/9295022\u003e.\n\n- if numOfBots == 1: bots will request HD (1280x720) from the active speaker.\n- if numOfBots \\\u003c 6: bots will request VGA (640x360) from all participants.\n- if numOfBots \\\u003c 16: bots will request HVGA (480x270) from all participants.\n- otherwise: bots will request HQVGA (240x135) from all participants.\n\n### HTTP request\n\n`POST https://botsondemand.googleapis.com/v1/createConferenceWithBots`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"numOfBots\": integer, \"ttlSecs\": integer, \"defaultBotOptions\": { object (/bots-on-demand/reference/rest/v1/createConferenceWithBots/create#BotOptions) }, \"perBotOptions\": [ { object (/bots-on-demand/reference/rest/v1/createConferenceWithBots/create#BotOptions) } ] } ``` |\n\n| Fields ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `numOfBots` | `integer` Required. The number of bots to add, must be between 1 - 50. |\n| `ttlSecs` | `integer` Required. TTL in seconds for the bots to stay in the meeting. |\n| `defaultBotOptions` | `object (`[BotOptions](/bots-on-demand/reference/rest/v1/createConferenceWithBots/create#BotOptions)`)` Optional. Default options for all bots created as part of this request. |\n| `perBotOptions[]` | `object (`[BotOptions](/bots-on-demand/reference/rest/v1/createConferenceWithBots/create#BotOptions)`)` Optional. Per bot options for bots created as part of this request. If fewer options are provided than the number of bots, the default options will be used for the remaining bots. |\n\n### Response body\n\nResponse for {@link CreateConferenceWithBotsRequest}\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------|\n| ``` { \"conferenceCode\": string, \"errorMessages\": [ string ] } ``` |\n\n| Fields ||\n|-------------------|----------------------------------------------------------|\n| `conferenceCode` | `string` The created conference. |\n| `errorMessages[]` | `string` The error messages returned by the failed bots. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/meetings`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nBotOptions\n----------\n\nOptions specific to individual bots\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requestedResolution\": enum (/bots-on-demand/reference/rest/v1/createConferenceWithBots/create#SupportedVideoResolutions), \"muteAudio\": boolean, \"muteVideo\": boolean, \"playbackVideo\": enum (/bots-on-demand/reference/rest/v1/createConferenceWithBots/create#VideoFile), \"outputResolution\": enum (/bots-on-demand/reference/rest/v1/createConferenceWithBots/create#SupportedVideoResolutions) } ``` |\n\n| Fields ||\n|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestedResolution` | `enum (`[SupportedVideoResolutions](/bots-on-demand/reference/rest/v1/createConferenceWithBots/create#SupportedVideoResolutions)`)` Optional. Incoming resolution requested by the bots. |\n| `muteAudio` | `boolean` Optional. Mute audio sent from bot, default False |\n| `muteVideo` | `boolean` Optional. Mute video sent from bot, default False |\n| `playbackVideo` | `enum (`[VideoFile](/bots-on-demand/reference/rest/v1/createConferenceWithBots/create#VideoFile)`)` Optional. The video file the bot should play |\n| `outputResolution` | `enum (`[SupportedVideoResolutions](/bots-on-demand/reference/rest/v1/createConferenceWithBots/create#SupportedVideoResolutions)`)` Optional. Outgoing video resolution sent by the bots, the will select a playback video matching this resolution. This is only used if playbackVideo is not set. |\n\nSupportedVideoResolutions\n-------------------------\n\nSupported video resolutions presets\n\n| Enums ||\n|-------------------------------------------|-------------------------------|\n| `SUPPORTED_VIDEO_RESOLUTIONS_UNSPECIFIED` | Resolution unspecified |\n| `THUMBNAIL_160_120` | Thumbnail resolution |\n| `QVGA_320_180` | QVGA resolution at 16:9 ratio |\n| `HVGA_480_270` | HVGA resolution at 16:9 ratio |\n| `VGA_640_360` | VGA resolution at 16:9 ratio |\n| `HD_1280_720` | HD resolution at 16:9 ratio |\n| `FHD_1920_1080` | FHD resolution at 16:9 ratio |\n\nVideoFile\n---------\n\nSupported playback videos for external partners\n\n| Enums ||\n|------------------------------|--------------------------------------|\n| `VIDEO_FILE_UNSPECIFIED` | File unspecified |\n| `SINGLE_ATTENDEE_IDLE_1` | Single meeting attendee sitting idle |\n| `SINGLE_ATTENDEE_CLAPPING_1` | Single meeting attendee clapping |"]]