Choose where you’d like to start

Post to Bot as an admin

Table of Contents

Note: This task is applicable to all Zoho Services, except Zoho Creator.

Overview

This task is used to post a message as an admin to any of the bots that you have subscribed, using the bot name in Zoho Cliq. The bot subscribers will receive your message and the sender will be displayed as admin.

This task is based on Zoho Cliq API - Post message to a bot.

Syntax

<variable> = zoho.cliq.postToBotAsAdmin(<bot_name>, <message>, <connection>);

where,

ParamsData typeDescription

<variable>

KEY-VALUE

is the variable which will hold the response returned by Zoho Cliq.

<bot_name>

TEXT

is the bot's name in which the message will be posted.

<message>

TEXT
KEY-VALUE
FILE 
LIST of FILE

is the message to be posted.

The different types of content that can be posted in a bot is found here.

<connection>

TEXT 

specifies the link name of the Zoho Cliq connection.

Note:

  • In view of stopping new authtoken generation, a Zoho OAuth connection with appropriate scopes is mandatory for new integration tasks (created after the deadline specified in the post) to work as expected. Existing integration tasks will continue to work with or without the connections parameter unless the authtoken is manually deleted from accounts.
  • Add relevant scopes as mentioned in Zoho Cliq API - Post to bot.
  • Refer to this post for the list of Zoho services that support the connections page.
  • Learn more about connections

Example

The following script posts a message Hello in the Bot - ZohoDeluge as an admin.

response = zoho.cliq.postToBotAsAdmin("ZohoDeluge", "Hello", "cliq_connection");

(or)

response = zoho.cliq.postToBotAsAdmin("ZohoDeluge",{"text":"Hello"}, "cliq_connection");

where,

response
is a KEY-VALUE response returned by Zoho Cliq, that represents the ZUID of the executed task
"ZohoDeluge"
is a TEXT that represents Bot name
"text"
is the key of TEXT data type which represents the message to be posted
"Hello"
is a TEXT message to be posted
"cliq_connection"
is the TEXT that represents the name of the connection

Sample Response

  • The following is a sample success response:

    {"users":["666667777"]}

  • The failure response returned for an incorrect Bot name is of the following format.

    {
    "message":"Sorry, we couldn't process your request due to a technical error. Please try again later.",
    "code":"operation_failed"
    }

Related Links

Get Started Now

Execute