Sending Slack Messages

Since Slack is a messaging channel specialized for team communication, Slack bots are usually expected to work either inside a channel or 1:1 chat.

Chatting in the channel makes collecting individual preferences efficiently. For example, we have a Slack bot to collect colleagues' afternoon tea orders.

Plus, Slack bot is especially good at notification scenarios, e.g., monitoring the health status of online service, or current stars of Bottender GitHub repo(Star it if you like it!). It is because Slack apps can post messages to channels, groups, or users without any extra fee.

While developing with Official Slack API, developers have to manage token, channel id, user id of each dialog. Bottender helps developers manage those parameters by context. Bot developers can always make a bot respond to its current context, no matter the context is Public Channels, Private Channels, Private Groups, or Direct Messaging.

Note:

• The idea of Bot connects to Slack's APP. It is important when you are cross-referencing Bottender doc with Slack's official doc.
• Since Slack is one of the sophisticated chat channels, in this doc, we only cover the most frequent use of methods. To access the full list of Slack API support of Bottender, you may refer to Bottender's API. If you are interested in Slack's complete methods, you may refer to Slack's official document, "API Methods.". Don't miss the Test tab next to each method; it offers a handy way to try native Slack API better.

Sending Text Messages

Text message is the most frequent and common message types. It also offers a minimal medium carrying out dynamic data, e.g., stock price and weather info.

async function SendHi(context) {
  await context.sendText('Hi!');
}

Posting Messages

This method posts a message to a public channel, private channel, or direct message. To fully support Slack's chat UI features, Bottender passes message parameters to Slack's API.

await context.chat.postMessage({
  text: 'Hello world!',
});

Note: For more info, please refer to Slack's official doc, chat.postMessage

Updating Messages

Updating existing messages is one of the unique features of Slack. It is useful when your bot displays a real-time date, and you don't want to have a frequently scrolling window.

In the above image, the second message is updated by Bottender. You may notice that while a user updated his message, a little annotation (edited) is shown next to the message, a bot update its existing message without (edited) annotation.

await context.chat.update({
  text: 'Hello world!',
  ts: '1405894322.002768',
});

Note:

• The ts parameter in the code above, refers to the timestamp of the message, which is a (per-channel) unique id of each message,
• Ephemeral messages created by chat.postEphemeral or otherwise cannot be updated with this method.
• For more info, please refer to Slack's official doc, chat.update

Deleting Messages

This method deletes a message posted by the bot from a channel.

await context.chat.delete({
  ts: '1405894322.002768',
});

Note:

• The ts parameter in the code above, refers to the timestamp of the message, which is a (per-channel) unique id of each message,
• For more info, please refer to Slack's official doc, chat.delete

Posting Ephemeral Messages

Bots can post Ephemeral Messages only visible to the assigned user in a specific public channel, private channel, or private conversation. In short, Ephemeral Messages allows bots to replies context-sensitive information to the user under current Bottender context. For example, when a user inputs check-in, the bot could post an Ephemeral Message to the user check-in time.

Note:

• Ephemeral Message delivery is not guaranteed — the user must be currently active in Slack and a member of the specified channel.
• For more info, please refer to Slack's official doc, chat.postEphemeral

await context.chat.postEphemeral({
  text: 'Hello world!',
});

Note:

• For more info, please refer to Slack's official doc, chat.postEphemeral

Sharing Me Messages

Share a me message into a channel.

await context.chat.meMessage({
  text: 'Hello world!',
});

Note:

• For more info, please refer to Slack's official doc, chat.meMessage

Retrieving A Permalink URL for Specific Extant Messages

Retrieve a permalink URL for a specific extant message

await context.chat.getPermalink({
  messageTs: '1234567890.123456',
});

Note:

• The messageTs parameter in the code above, refers to the timestamp of the message, which is a (per-channel) unique id of each message,
• For more info, please refer to Slack's official doc, chat.getPermalink

Scheduling Messages

Slack owns a built-in message scheduling system. For other chat channels, you probably have to run a cronjob to schedule messages.

Scheduling Messages

Schedules a message to be sent to a channel.

await context.chat.scheduleMessage({
  text: 'Hello world!',
  postAt: '299876400',
});

Note:

• The postAt parameter in the code above follows Unix EPOCH timestamp.
• For more info, please refer to Slack's official doc, chat.scheduleMessage

Getting a List of Scheduled Messages

You can get a list of scheduled messages by the following code.

await context.chat.scheduledMessages.list();

Note:

• For more info, please refer to Slack's official doc, chat.scheduledMessages.list

Deleting Pending Scheduled Messages

First, you have to use chat.scheduledMessages.list to figure out the <SCHEDULED_MESSAGE_ID> you want to delete. Then you can use the below method to delete a scheduled message.

await context.chat.deleteScheduledMessage({
  scheduledMessageId: '<SCHEDULED_MESSAGE_ID>',
});

Note:

• For more info, please refer to Slack's official doc, chat.deleteScheduledMessage