@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
103 lines (102 loc) • 3.11 kB
JSON
{
"post": {
"operationId": "getChannelsIds",
"summary": "Retrieves a map of channel IDs to channel names.",
"description": "Returns an array of minimal objects, each containing the ID and name of a channel in the workspace. This is a helper to get the channel IDs by names.",
"tags": [
"channel"
],
"ai": {
"systemPrompt": "Lists all public and private channels in the workspace and returns a map of their IDs and names. Use this when searching for channelId by channel name.",
"disableTool": true
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"body": {
"type": "object",
"description": "Body of the getChannelsIds sls call",
"properties": {
"arguments": {
"type": "object",
"description": "Container for function arguments.",
"properties": {
"cursor": {
"type": "string",
"description": "A cursor to the next page of results."
},
"limit": {
"type": "number",
"description": "The maximum number of channels to return. Defaults to 50."
}
}
}
},
"required": [
"arguments"
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the channel."
},
"name": {
"type": "string",
"description": "The name of the channel."
}
},
"required": [
"id",
"name"
]
}
},
"nextCursor": {
"type": "string",
"description": "A cursor to the next page of results"
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
}
}
}
}
}
}