chatScheduledMessagesList
Returns a list of scheduled messages.
Details
- Method:
GET - Path:
/chat.scheduledMessages.list - Operation ID:
chat_scheduledMessages_list
Parameters
{
"token": {
"description": "Authentication token. Requires scope: `none`",
"required": false,
"location": "header",
"type": "string"
},
"channel": {
"description": "The channel of the scheduled messages",
"required": false,
"location": "query",
"type": "string"
},
"latest": {
"description": "A UNIX timestamp of the latest value in the time range",
"required": false,
"location": "query",
"type": "string"
},
"oldest": {
"description": "A UNIX timestamp of the oldest value in the time range",
"required": false,
"location": "query",
"type": "string"
},
"limit": {
"description": "Maximum number of original entries to return.",
"required": false,
"location": "query",
"type": "string"
},
"cursor": {
"description": "For pagination purposes, this is the `cursor` value returned from a previous call to `chat.scheduledmessages.list` indicating where you want to start this call from.",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"additionalProperties": false,
"description": "Schema for successful response from chat.scheduledMessages.list method",
"properties": {
"ok": {
"enum": [
true
],
"title": "default success response",
"type": "boolean"
},
"response_metadata": {
"additionalProperties": false,
"properties": {
"next_cursor": {
"type": "string"
}
},
"required": [
"next_cursor"
],
"type": "object"
},
"scheduled_messages": {
"items": {
"additionalProperties": false,
"properties": {
"channel_id": {
"pattern": "^[C][A-Z0-9]{2,}$",
"title": "Channel ID",
"type": "string"
},
"date_created": {
"pattern": "^\\d{10}$",
"type": "integer"
},
"id": {
"pattern": "^[Q][A-Z0-9]{8,}$",
"type": "string"
},
"post_at": {
"pattern": "^\\d{10}$",
"type": "integer"
},
"text": {
"type": "string"
}
},
"required": [
"id",
"channel_id",
"post_at",
"date_created"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"ok",
"scheduled_messages",
"response_metadata"
],
"title": "chat.scheduledMessages.list schema",
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('slack')
# Call this tool
result = await agent.call_tool('chatScheduledMessagesList', {
# Add required parameters here
})