Packages

A Slack Web & Real Time Messaging API client.

Retired package: Renamed - 1.0.0-alpha.0

Current section

Files

Jump to
slack_kit lib slack web docs chat.scheduleMessage.json
Raw

lib/slack/web/docs/chat.scheduleMessage.json

{
"args": {
"as_user": {
"desc": "Set to `true` to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps. See chat.postMessage.",
"example": "true",
"required": false,
"type": "boolean"
},
"attachments": {
"desc": "A JSON-based array of structured attachments, presented as a URL-encoded string.",
"example": "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]",
"required": false,
"type": "string"
},
"blocks": {
"desc": "A JSON-based array of structured blocks, presented as a URL-encoded string.",
"example": "[{\"type\": \"section\", \"text\": {\"type\": \"plain_text\", \"text\": \"Hello world\"}}]",
"required": false,
"type": "string"
},
"channel": {
"desc": "Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.",
"required": true,
"type": "string"
},
"link_names": {
"desc": "Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.",
"example": "true",
"required": false,
"type": "boolean"
},
"markdown_text": {
"desc": "Accepts message text formatted in markdown. This argument should not be used in conjunction with `blocks` or `text`. Limit this field to 12,000 characters.",
"example": "**This is bold text**",
"required": false,
"type": "string"
},
"metadata": {
"desc": "JSON object with event\\_type and event\\_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.",
"example": "{\"event_type\": \"task_created\", \"event_payload\": { \"id\": \"11223\", \"title\": \"Redesign Homepage\"}}",
"required": false
},
"parse": {
"desc": "Change how messages are treated. See chat.postMessage.\n\n_Acceptable values:_ `none` `full`",
"example": "full",
"required": false,
"type": "string"
},
"post_at": {
"desc": "Unix timestamp representing the future time the message should post to Slack.",
"example": "299876400",
"required": true,
"type": "integer"
},
"reply_broadcast": {
"desc": "Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.",
"example": "true",
"required": false,
"type": "boolean"
},
"text": {
"desc": "How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.",
"example": "Hello world",
"required": false,
"type": "string"
},
"thread_ts": {
"desc": "Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.",
"required": false,
"type": "string"
},
"unfurl_links": {
"desc": "Pass true to enable unfurling of primarily text-based content.",
"example": "true",
"required": false,
"type": "boolean"
},
"unfurl_media": {
"desc": "Pass false to disable unfurling of media content.",
"example": "false",
"required": false,
"type": "boolean"
}
},
"desc": "Schedules a message to be sent to a channel.",
"errors": {
"access_denied": "Access to a resource specified in the request is denied.",
"accesslimited": "Access to this method is limited on the current network",
"account_inactive": "Authentication token is for a deleted user or workspace when using a `bot` token.",
"channel_not_found": "Value passed for `channel` was invalid.",
"deprecated_endpoint": "The endpoint has been deprecated.",
"ekm_access_denied": "Administrators have suspended the ability to post a message.",
"enterprise_is_restricted": "The method cannot be called from an Enterprise.",
"fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.",
"internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.",
"invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than `_`. If you get this error, it is typically an indication that you have made a _very_ malformed API call.",
"invalid_arguments": "The method was called with invalid arguments.",
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
"invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.",
"invalid_blocks": "Blocks submitted with this message are not valid",
"invalid_blocks_format": "The `blocks` is not a valid JSON object or doesn't match the Block Kit syntax.",
"invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.",
"invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.",
"invalid_metadata_format": "Invalid metadata format provided",
"invalid_metadata_schema": "Invalid metadata schema provided",
"invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.",
"invalid_time": "value passed for `post_time` was invalid.",
"invalid_token": "The passed token is invalid or not supported by this method.",
"is_archived": "Channel has been archived.",
"markdown_text_conflict": "Markdown text cannot be used in conjunction with `blocks` or `text` argument.",
"message_limit_exceeded": "Members on this team are sending too many messages. For more details, see https://slack.com/help/articles/115002422943-Usage-limits-for-free-workspaces",
"metadata_must_be_sent_from_app": "Message metadata can only be posted or updated using an app-level token",
"metadata_too_large": "Metadata exceeds size limit",
"method_deprecated": "The method has been deprecated.",
"missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.",
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
"msg_too_long": "Message text is too long",
"no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.",
"no_text": "No message text provided",
"not_allowed_token_type": "The token type used in this request is not allowed.",
"not_authed": "No authentication token provided.",
"not_in_channel": "Cannot post user messages to a channel they are not in.",
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
"rate_limited": "Application has posted too many messages, read the Rate Limit documentation for more information",
"ratelimited": "The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.",
"request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.",
"restricted_action": "A workspace preference prevents the authenticated user from posting.",
"restricted_action_non_threadable_channel": "Cannot post thread replies into a non\\_threadable channel.",
"restricted_action_read_only_channel": "Cannot post any message into a read-only channel.",
"restricted_action_thread_only_channel": "Cannot post top-level messages into a thread-only channel.",
"restricted_too_many": "Too many messages were scheduled in the channel for a given period. See usage info for additional details",
"service_unavailable": "The service is temporarily unavailable",
"slack_connect_file_link_sharing_blocked": "Admin has disabled Slack File sharing in all Slack Connect communications",
"team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.",
"team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.",
"time_in_past": "value passed for `post_time` was in the past.",
"time_too_far": "value passed for `post_time` was too far into the future.",
"token_expired": "Authentication token has expired",
"token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a `user` token.",
"too_many_attachments": "Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.",
"two_factor_setup_required": "Two factor setup is required."
}
}