messaging-api-slack

messaging-api-slack

Messaging API client for Slack

Table of Contents

• Installation
• OAuth Client
  • Usage
  • API Reference
• Webhook Client
  • Usage
  • API Reference

Installation

npm i --save messaging-api-slack

or

yarn add messaging-api-slack

OAuth Client

Usage

Get your bot user OAuth access token by setup OAuth & Permissions function to your app or check the Using OAuth 2.0 document.

const { SlackOAuthClient } = require('messaging-api-slack');

// get access token by setup OAuth & Permissions function to your app.
// https://api.slack.com/docs/oauth
const client = SlackOAuthClient.connect(
  'xoxb-000000000000-xxxxxxxxxxxxxxxxxxxxxxxx'
);

API Reference

All methods return a Promise.

Call available methods

callMethod(method, body) - Official docs

method

Type: String Value: One of chat.postMessage | 'channels.info' | 'channels.list' | 'users.info' | 'users.list

body

Type: Object

client.callMethod('chat.postMessage', { channel: 'C8763', text: 'Hello!' });

Chat API

postMessage(channel, text, options?) - Official docs

channel

Type: String

text

Type: String

options

Type: Object

client.postMessage('C8763', 'Hello!');
client.postMessage('C8763', 'Hello!', { as_user: true });

Users API

getUserList(cursor?) - Official docs

cursor

Type: String

client.getUserList(CURSOR).then(res => {
  console.log(res);
  // [
  //   { ... },
  //   { ... },
  // ]
});

getAllUserList() - Official docs

client.getAllUserList().then(res => {
  console.log(res);
  // [
  //   { ... },
  //   { ... },
  // ]
});

getUserInfo(userId) - Official docs

userId

Type: String

client.getUserInfo(userId).then(res => {
  console.log(res);
  // {
  //   id: 'U123456',
  //   name: 'bobby',
  //   ...
  // }
});

Channels API

getChannelList() - Official docs

client.getChannelList().then(res => {
  console.log(res);
  // [
  //   { ... },
  //   { ... },
  // ]
});

getChannelInfo(channelId) - Official docs

channelId

Type: String

client.getChannelInfo(channelId).then(res => {
  console.log(res);
  // {
  //   id: 'C8763',
  //   name: 'fun',
  //   ...
  // }
});

Webhook Client

Usage

Get your webhook url by adding a Incoming Webhooks integreation to your team or setup Incoming Webhooks function to your app.

const { SlackWebhookClient } = require('messaging-api-slack');

// get webhook URL by adding a Incoming Webhook integration to your team.
// https://my.slack.com/services/new/incoming-webhook/
const client = SlackWebhookClient.connect(
  'https://hooks.slack.com/services/XXXXXXXX/YYYYYYYY/zzzzzZZZZZ'
);

API Reference

All methods return a Promise.

Send API - Official docs

sendRawBody(body)

body

Type: Object

client.sendRawBody({ text: 'Hello!' });

sendText(text)

text

Type: String

client.sendText('Hello!');

sendAttachments(attachments) - Official docs

attachments

Type: Array<Object>

client.sendAttachments([
  {
    fallback: 'some text',
    pretext: 'some pretext',
    color: 'good',
    fields: [
      {
        title: 'aaa',
        value: 'bbb',
        short: false,
      },
    ],
  },
  {
    fallback: 'some other text',
    pretext: 'some pther pretext',
    color: '#FF0000',
    fields: [
      {
        title: 'ccc',
        value: 'ddd',
        short: false,
      },
    ],
  },
]);

sendAttachment(attachment) - Official docs

attachment

Type: Object

client.sendAttachment({
  fallback: 'some text',
  pretext: 'some pretext',
  color: 'good',
  fields: [
    {
      title: 'aaa',
      value: 'bbb',
      short: false,
    },
  ],
});

Changelog

0.2.6 / 2017-08-14

messaging-api-messenger

• [new] Support calling send API with recipient object:

client.sendText(
  {
    phone_number: '[phone]',
    name: { first_name: 'John', last_name: 'Doe' },
  },
  'Hello World'
);

• [new] Support send media (sendAudio、sendImage、sendVideo、sendFile) using Buffer or ReadStream:

client.sendImage(USER_ID, buffer);
client.sendFile(USER_ID, fs.createReadStream('LookGreatToMe.pdf'));

messaging-api-slack

• [docs] Added Slack OAuth API document