@microfox/slack
Version:
This package provides a lightweight, proxy interface to the official Slack Web API, offering a curated set of the most commonly used functions for building Slack integrations. It is designed to be simple, efficient, and easy to integrate into your project
50 lines (37 loc) • 2.32 kB
Markdown
# messageChannel
The `messageChannel` method sends a message to a specific channel.
## Usage
```typescript
import { MicrofoxSlackClient } from '@microfox/slack';
const client = new MicrofoxSlackClient(process.env.SLACK_BOT_TOKEN);
(async () => {
try {
const result = await client.messageChannel('C12345678', 'Hello everyone!');
console.log('Message sent: ', result.ts);
} catch (error) {
console.error(error);
}
})();
```
## Arguments
- `channelId` (string): The ID of the channel to send the message to.
- `text` (string): The text of the message.
## Response
This method returns an object containing the result of the API call.
### Response Schema
| Property | Type | Description |
| --------- | ------ | -------------------------------------------------------------------------------------------------------- |
| `ok` | Boolean| `true` if the request was successful. |
| `channel` | String | The ID of the channel where the message was posted. |
| `ts` | String | The timestamp of the message. |
| `message` | Object | An object containing the details of the sent message. See Message Object Schema below. |
### Message Object Schema
| Property | Type | Description |
| ----------- | ------- | --------------------------------------------------------------- |
| `type` | String | The type of message. |
| `subtype` | String | The subtype of the message. |
| `text` | String | The text of the message. |
| `ts` | String | The timestamp of the message. |
| `bot_id` | String | The ID of the bot that sent the message. |
| `username` | String | The username of the bot that sent the message. |
| `attachments` | Array | An array of attachments. |