Class SlackOAuthClient

scheduledMessages: { list: any }

• list:function

  • list(options: GetScheduledMessagesOptions): Promise<OAuthAPIResponse>

  • Returns a list of scheduled messages.

    see

    https://api.slack.com/methods/chat.scheduledMessages.list

    example

    await client.chat.scheduledMessages.list({
      channel: 'C123456789',
    });
    

    Parameters

    • options: GetScheduledMessagesOptions

    Returns Promise<OAuthAPIResponse>

    Typical success response

    {
      "ok": true,
      "scheduledMessages": [
        {
          "id": 1298393284,
          "channelId": "C1H9RESGL",
          "postAt": 1551991428,
          "dateCreated": 1551891734,
          "text": "Here's a message for you in the future"
        }
      ],
      "responseMetadata": {
        "nextCursor": ""
      }
    }
    

delete:function

• delete(options: DeleteMessageOptions): Promise<OAuthAPIResponse>

• Deletes a message.

  see

  https://api.slack.com/methods/chat.delete

  example

  await client.chat.delete({
    channel: 'C1234567890',
    ts: 'Timestamp of the message to be deleted.',
  });
  

  Parameters

  • options: DeleteMessageOptions

  Returns Promise<OAuthAPIResponse>

  Typical success response

  {
    "ok": true,
    "channel": "C024BE91L",
    "ts": "1401383885.000061"
  }
  

deleteScheduledMessage:function

• deleteScheduledMessage(options: DeleteScheduledMessageOptions): Promise<OAuthAPIResponse>

• Deletes a pending scheduled message from the queue.

  see

  https://api.slack.com/methods/chat.deleteScheduledMessage

  example

  await client.chat.deleteScheduledMessage({
    channel: 'C123456789',
    scheduledMessageId: 'Q1234ABCD',
  });
  

  Parameters

  • options: DeleteScheduledMessageOptions

  Returns Promise<OAuthAPIResponse>

  Typical success response

  {
    "ok": true
  }
  

getPermalink:function

• getPermalink(options: GetPermalinkOptions): Promise<OAuthAPIResponse>

• Retrieve a permalink URL for a specific extant message.

  see

  https://api.slack.com/methods/chat.getPermalink

  example

  await client.chat.getPermalink({
    channel: 'C1H9RESGA',
    messageTs: '1234567890.123456',
  });
  

  Parameters

  • options: GetPermalinkOptions

  Returns Promise<OAuthAPIResponse>

  Standard success response

  {
    "ok": true,
    "channel": "C1H9RESGA",
    "permalink": "https://ghostbusters.slack.com/archives/C1H9RESGA/p135854651500008"
  }
  

meMessage:function

• meMessage(options: MeMessageOptions): Promise<OAuthAPIResponse>

• Share a me message into a channel.

  see

  https://api.slack.com/methods/chat.meMessage

  example

  await client.chat.meMessage({
    channel: 'C1234567890',
    text: 'Hello world',
  });
  

  Parameters

  • options: MeMessageOptions

  Returns Promise<OAuthAPIResponse>

  Typical success response

  {
    "ok": true,
    "channel": "C024BE7LR",
    "ts": "1417671948.000006"
  }
  

postEphemeral:function

• postEphemeral(options: PostEphemeralOptions): Promise<OAuthAPIResponse>

• Sends an ephemeral message to a user in a channel.

  see

  https://api.slack.com/methods/chat.postEphemeral

  example

  await client.chat.postEphemeral({
    channel: 'C1234567890',
    text: 'Hello world',
    user: 'U0BPQUNTA',
    attachments: '[{"pretext": "pre-hello", "text": "text-world"}]',
  });
  

  Parameters

  • options: PostEphemeralOptions

  Returns Promise<OAuthAPIResponse>

  Typical success response

  {
    "ok": true,
    "messageTs": "1502210682.580145"
  }
  

postMessage:function

• postMessage(options: PostMessageOptions): Promise<OAuthAPIResponse>

• Sends a message to a channel.

  see

  https://api.slack.com/methods/chat.postMessage

  example

  await client.chat.postMessage({
    channel: 'C1234567890',
    text: 'Hello world',
  });
  

  Parameters

  • options: PostMessageOptions

  Returns Promise<OAuthAPIResponse>

  Typical success response

  {
    "ok": true,
    "channel": "C1H9RESGL",
    "ts": "1503435956.000247",
    "message": {
       "text": "Here's a message for you",
       "username": "ecto1",
       "botId": "B19LU7CSY",
       "attachments": [
          {
            "text": "This is an attachment",
            "id": 1,
            "fallback": "This is an attachment's fallback"
          }
        ],
        "type": "message",
        "subtype": "bot_message",
        "ts": "1503435956.000247"
      }
    }
  }
  

scheduleMessage:function

• scheduleMessage(options: ScheduleMessageOptions): Promise<OAuthAPIResponse>

• Schedules a message to be sent to a channel.

  see

  https://api.slack.com/methods/chat.scheduleMessage

  example

  await client.chat.scheduleMessage({
    channel: 'C1234567890',
    postAt: '299876400',
    text: 'Hello world',
  });
  

  Parameters

  • options: ScheduleMessageOptions

  Returns Promise<OAuthAPIResponse>

  Typical success response

  {
    "ok": true,
    "channel": "C1H9RESGL",
    "scheduledMessageId": "Q1298393284",
    "postAt": "1562180400",
    "message": {
      "text": "Here's a message for you in the future",
      "username": "ecto1",
      "botId": "B19LU7CSY",
      "attachments": [
        {
          "text": "This is an attachment",
          "id": 1,
          "fallback": "This is an attachment's fallback"
        }
      ],
      "type": "delayed_message",
      "subtype": "bot_message"
    }
  }
  

unfurl:function

• unfurl(options: UnfurlOptions): Promise<OAuthAPIResponse>

• Provide custom unfurl behavior for user-posted URLs.

  see

  https://api.slack.com/methods/chat.unfurl

  example

  await client.chat.unfurl({
    channel: 'C123456789',
    ts: '1502210682.580145',
    unfurls: {
      'https://example.com/': {
        text: 'Every day is the test.',
      },
    },
  });
  

  Parameters

  • options: UnfurlOptions

  Returns Promise<OAuthAPIResponse>

  Typical, minimal success response

  {
    "ok": true
  }
  

update:function

• update(options: UpdateMessageOptions): Promise<OAuthAPIResponse>

• Updates a message.

  see

  https://api.slack.com/methods/chat.update

  example

  await client.chat.update({
    channel: 'C1234567890',
    ts: '1405894322.002768',
    text: 'Hello world',
  });
  

  Parameters

  • options: UpdateMessageOptions

  Returns Promise<OAuthAPIResponse>

  Typical success response

  {
    "ok": true,
    "channel": "C024BE91L",
    "ts": "1401383885.000061",
    "text": "Updated text you carefully authored",
    "message": {
      "text": "Updated text you carefully authored",
      "user": "U34567890"
    }
  }
  

open:function

• open(options: OpenViewOptions): Promise<OAuthAPIResponse>

• Open a view for a user.

  see

  https://api.slack.com/methods/views.open

  example

  await client.views.open({
    triggerId: '12345.98765.abcd2358fdea',
    view: {
      id: 'VMHU10V25',
      teamId: 'T8N4K1JN',
      type: 'modal',
      title: {
        type: 'plain_text',
        text: 'Quite a plain modal',
      },
      submit: {
        type: 'plain_text',
        text: 'Create',
      },
      blocks: [
        {
          type: 'input',
          blockId: 'a_block_id',
          label: {
            type: 'plain_text',
            text: 'A simple label',
            emoji: true,
          },
          optional: false,
          element: {
            type: 'plain_text_input',
            actionId: 'an_action_id',
          },
        },
      ],
      privateMetadata: 'Shh it is a secret',
      callbackId: 'identify_your_modals',
      externalId: '',
      state: {
        values: [],
      },
      hash: '156772938.1827394',
      clearOnClose: false,
      notifyOnClose: false,
    },
  });
  

  Parameters

  • options: OpenViewOptions

  Returns Promise<OAuthAPIResponse>

  Typical success response includes the opened view payload.

publish:function

• publish(options: PublishViewOptions): Promise<OAuthAPIResponse>

• Publish a static view for a User.

  see

  https://api.slack.com/methods/views.publish

  example

  await client.views.publish({
    userId: 'U0BPQUNTA',
    view: {
      id: 'VMHU10V25',
      teamId: 'T8N4K1JN',
      type: 'modal',
      title: {
        type: 'plain_text',
        text: 'Quite a plain modal',
      },
      submit: {
        type: 'plain_text',
        text: 'Create',
      },
      blocks: [
        {
          type: 'input',
          blockId: 'a_block_id',
          label: {
            type: 'plain_text',
            text: 'A simple label',
            emoji: true,
          },
          optional: false,
          element: {
            type: 'plain_text_input',
            actionId: 'an_action_id',
          },
        },
      ],
      privateMetadata: 'Shh it is a secret',
      callbackId: 'identify_your_modals',
      externalId: '',
      state: {
        values: [],
      },
      hash: '156772938.1827394',
      clearOnClose: false,
      notifyOnClose: false,
    },
    hash: '156772938.1827394,
  });
  

  Parameters

  • options: PublishViewOptions

  Returns Promise<OAuthAPIResponse>

  Typical success response includes the published view payload.

push:function

• push(options: PushViewOptions): Promise<OAuthAPIResponse>

• Push a view onto the stack of a root view.

  see

  https://api.slack.com/methods/views.push

  example

  await client.views.push({
    triggerId: '12345.98765.abcd2358fdea',
    view: {
      id: 'VMHU10V25',
      teamId: 'T8N4K1JN',
      type: 'modal',
      title: {
        type: 'plain_text',
        text: 'Quite a plain modal',
      },
      submit: {
        type: 'plain_text',
        text: 'Create',
      },
      blocks: [
        {
          type: 'input',
          blockId: 'a_block_id',
          label: {
            type: 'plain_text',
            text: 'A simple label',
            emoji: true,
          },
          optional: false,
          element: {
            type: 'plain_text_input',
            actionId: 'an_action_id',
          },
        },
      ],
      privateMetadata: 'Shh it is a secret',
      callbackId: 'identify_your_modals',
      externalId: '',
      state: {
        values: [],
      },
      hash: '156772938.1827394',
      clearOnClose: false,
      notifyOnClose: false,
    },
  });
  

  Parameters

  • options: PushViewOptions

  Returns Promise<OAuthAPIResponse>

  Typical success response includes the pushed view payload.

update:function

• update(options: UpdateViewOptions): Promise<OAuthAPIResponse>

• Update an existing view.

  see

  https://api.slack.com/methods/views.update

  example

  await client.views.update({
    externalId: 'bmarley_view2',
    view: {
      id: 'VMHU10V25',
      teamId: 'T8N4K1JN',
      type: 'modal',
      title: {
        type: 'plain_text',
        text: 'Quite a plain modal',
      },
      submit: {
        type: 'plain_text',
        text: 'Create',
      },
      blocks: [
        {
          type: 'input',
          blockId: 'a_block_id',
          label: {
            type: 'plain_text',
            text: 'A simple label',
            emoji: true,
          },
          optional: false,
          element: {
            type: 'plain_text_input',
            actionId: 'an_action_id',
          },
        },
      ],
      privateMetadata: 'Shh it is a secret',
      callbackId: 'identify_your_modals',
      externalId: '',
      state: {
        values: [],
      },
      hash: '156772938.1827394',
      clearOnClose: false,
      notifyOnClose: false,
    },
  });
  

  Parameters

  • options: UpdateViewOptions

  Returns Promise<OAuthAPIResponse>

  Typical success response includes the updated view payload.