Skip to navigation

Send Command

View as Markdown

Send a command to a bot that is in a live meeting. Use raise_hand to raise the bot’s hand, lower_hand to lower it, or screenshot to capture the meeting. Hand commands use the meeting’s own raise-hand control, so everyone in the meeting sees the change. Screenshots are supported on Google Meet, Teams and Zoom bots that join without your own Zoom app; Zoom bots using your own app (Meeting SDK) do not support them. Retrieve captures with Get Bot Screenshots.

For hand commands, the response includes hand_raised: the hand state the bot read back from the meeting after it acted. A repeated hand command changes nothing and returns 200 with the current state. hand_raised does not apply to screenshot.

Supported on Google Meet, Zoom and Microsoft Teams. The bot must be in the meeting (status InMeeting, Recording or RecordingPermissionAllowed). Allow up to 10 seconds for a response. Shares the 30 requests per minute per bot limit with the other in-meeting commands. See the Raise & Lower Hand guide.

Authentication

AuthorizationToken

Format: Token <your_api_key>

Path parameters

bot_idstringRequired
The ID returned when the bot was created.

Request

This endpoint expects an object.
commandenumRequired

raise_hand raises the bot’s hand. lower_hand lowers it. screenshot captures the meeting when the bot’s platform and join method support it.

Allowed values:

Response

The bot accepted the command. Hand commands include hand_raised, the hand state after the command.

statusenum
Allowed values:
bot_idstring
commandenum
Allowed values:
hand_raisedbooleanOptional

The hand state the bot read back from the meeting after it acted: true when the hand is up. Not an echo of the request. Present for hand commands, not screenshots.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
501
Not Implemented Error
502
Bad Gateway Error
503
Service Unavailable Error