sendChatbotMessages.Rd
Send chatbot messages from your marketplace chatbot app.**Scopes:** imchat:bot ** Rate Limit Label https://marketplace.zoom.us/docs/apireference/ratelimits#ratelimits :** Medium**Authorization Flow**: Client Credentials FlowTo get authorized, make a POST request to /oauth/token endpoint with grant type as client_credentials. Use https://api.zoom.us/oauth/token?grant_type=client_credentials as the endpoint for the request. You will need to send your ClientID and Secret as a Basic base64 encoded AUthorization header. Ex. Basic base64Encode client_id:client_sceret Next, use the token recieved access_token as a bearer token while making the POST /im/chat/messages request to send chatbot messages.Learn more about how to authorize chatbots in the Chatbot Authorization https://marketplace.zoom.us/docs/guides/chatbots/authorization guide.
sendChatbotMessages( robot_jid, to_jid, account_id, content, visible_to_user = NULL, user_jid = NULL, is_markdown_support = NULL, return_response = F )
robot_jid | Robot JID created when enabling chatbot features on your marketplace app. |
---|---|
to_jid | Unique JID of reciever. Can be a group or user. |
account_id | Account ID of the authorized account. |
content | JSON template describing how the message should be displayed for the user. For more information please see our "Send Message" templates https://marketplace.zoom.us/docs/guides/chatbots/sendingmessages#examplerequest . |
visible_to_user | **Optional**Allow a Chatbot to send a message to a group channel, but have only one designated person in that group channel see the message by providing the person's UserID in this field. |
user_jid | **Optional**The UserJID of the user on whose behalf the message is being sent. Use this field to prevent members of a channel from getting notifications that were set up by a user who has left the channel. |
is_markdown_support | **Optional**Applies the markdown parser to your chatbot message if the value of this field is set to true. To learn more, refer to the Chatbot message markdown reference https://marketplace.zoom.us/docs/guides/chatbots/customizingmessages/messagewithmarkdown . |
return_response | Whether to return the response instead of the response content. Defaults to FALSE. |