chat.scheduledMessages.list

Returns a list of scheduled messages.

Facts

Method access

HTTP
JavaScript
Python
Java
HTTP
POSThttps://slack.com/api/chat.scheduledMessages.list
Bolt for Java
app.client().chatScheduledMessagesList
Powered by Bolt
Bolt for Python
app.client.chat_scheduledMessages_list
Powered by Bolt
Bolt for JavaScript
app.client.chat.scheduledMessages.list
Powered by Bolt

Required scopes

Bot tokensNo scope required
User tokensNo scope required

Content types

application/x-www-form-urlencodedapplication/json
  • Rate limits

    Tier 3
  • Arguments

    ArgumentTypeDescription
    tokenRequired

    Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

    Examplexxxx-xxxxxxxxx-xxxx
    channel
    string

    The channel of the scheduled messages

    ExampleC123456789
    cursor
    string

    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.

    ExampledXNlcjpVMDYxTkZUVDI=
    latest
    string

    A UNIX timestamp of the latest value in the time range

    Example1562137200
    limit
    integer

    Maximum number of original entries to return.

    Example100
    oldest
    string

    A UNIX timestamp of the oldest value in the time range

    Example1562137200
    team_id
    string

    encoded team id to list channels in, required if org token is used

    ExampleT1234567890

    This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.

    Example responses

    Common successful response

    Typical success response

    {
        "ok": true,
        "scheduled_messages": [
            {
                "id": 1298393284,
                "channel_id": "C1H9RESGL",
                "post_at": 1551991428,
                "date_created": 1551891734,
                "text": "Here's a message for you in the future"
            }
        ],
        "response_metadata": {
            "next_cursor": ""
        }
    }
    Common error response

    Typical error response if the channel passed is invalid

    {
        "ok": false,
        "error": "invalid_channel"
    }

    This method returns a list of pending scheduled messages.

    oldest signifies the UNIX timestamp of the earliest range you're interested in. latest signifies the latest. If both oldest and latest are specified, oldest must be less than latest.

    Errors

    This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

    ErrorDescription
    invalid_channel

    The channel passed is invalid

    invalid_token

    Token is invalid

    invalid_cursor

    Provided cursor is invalid

    not_authed

    No authentication token provided.

    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.

    account_inactive

    Authentication token is for a deleted user or workspace when using a bot token.

    token_revoked

    Authentication token is for a deleted user or workspace or the app has been removed when using a user token.

    token_expired

    Authentication token has expired

    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.

    org_login_required

    The workspace is undergoing an enterprise migration and will not be available until migration is complete.

    ekm_access_denied

    Administrators have suspended the ability to post a message.

    missing_scope

    The token used is not granted the specific scope permissions required to complete this request.

    not_allowed_token_type

    The token type used in this request is not allowed.

    method_deprecated

    The method has been deprecated.

    deprecated_endpoint

    The endpoint has been deprecated.

    two_factor_setup_required

    Two factor setup is required.

    enterprise_is_restricted

    The method cannot be called from an Enterprise.

    team_access_not_granted

    The token used is not granted the specific workspace access required to complete this request.

    invalid_arguments

    The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.

    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_array_arg

    The method was passed an array as an argument. Please only input valid strings.

    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_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.

    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.

    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.

    ratelimited

    The request has been ratelimited. Refer to the Retry-After header for when to retry the request.

    accesslimited

    Access to this method is limited on the current network

    request_timeout

    The method was called via a POST request, but the POST data was either missing or truncated.

    service_unavailable

    The service is temporarily unavailable

    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.

    Warnings

    This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

    WarningDescription
    missing_charset

    The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.

    superfluous_charset

    The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.

    Arguments

    Need a token? Create and install a Slack app to begin.
    This will make a real API request. Beware of using it with live workspaces.

    API response


    Submit your arguments to see the API response
    Listing scheduled messages
    Java
    JavaScript
    Python
    HTTP
    Java
    import com.slack.api.Slack;
    import com.slack.api.methods.SlackApiException;
    import org.slf4j.LoggerFactory;
    
    import java.io.IOException;
    
    public class ChatScheduledMessagesList {
    
        /**
         * Lists scheduled messages using latest and oldest timestamps
         */
        static void listScheduledMessages(String latest, String oldest) {
            // you can get this instance via ctx.client() in a Bolt app
            var client = Slack.getInstance().methods();
            var logger = LoggerFactory.getLogger("my-awesome-slack-app");
            try {
                // Call the chat.scheduledMessages.list method using the built-in WebClient
                var result = client.chatScheduledMessagesList(r -> r
                    // The token you used to initialize your app
                    .token(System.getenv("SLACK_BOT_TOKEN"))
                    .latest(latest)
                    .oldest(oldest)
                );
                // Print scheduled messages
                for (var message : result.getScheduledMessages()) {
                    logger.info("message: {}", message);
                }
                // Print result
                logger.info("result: {}", result);
            } catch (IOException | SlackApiException e) {
                logger.error("error: {}", e.getMessage(), e);
            }
        }
    
        public static void main(String[] args) throws Exception {
            listScheduledMessages("1551991429", "1551991427");
        }
    
    }
    
    JavaScript
    Code to initialize Bolt app
    // Require the Node Slack SDK package (github.com/slackapi/node-slack-sdk) const { WebClient, LogLevel } = require("@slack/web-api"); // WebClient insantiates a client that can call API methods // When using Bolt, you can use either `app.client` or the `client` passed to listeners. const client = new WebClient("xoxb-your-token", { // LogLevel can be imported and used to make debugging simpler logLevel: LogLevel.DEBUG });
    // List scheduled messages using latest and oldest timestamps async function listScheduledMessages(latest, oldest) { try { // Call the chat.scheduledMessages.list method using the WebClient const result = await client.chat.scheduledMessages.list({ latest: latest, oldest: oldest }); // Print scheduled messages for (const message of result.scheduled_messages) { console.log(message); } } catch (error) { console.error(error); } } listScheduledMessages("1551991429", "2661991427");
    Python
    Code to initialize Bolt app
    import os import logging from slack_sdk.errors import SlackApiError from slack_sdk.web import WebClient client = WebClient(token=os.environ["SLACK_BOT_TOKEN"]) logger = logging.getLogger(__name__)
    # List scheduled messages using latest and oldest timestamps def list_scheduled_messages(latest, oldest): try: # Call the chat.scheduledMessages.list method using the WebClient result = client.chat_scheduledMessages_list( latest=latest, oldest=oldest ) # Print scheduled messages for message in result["scheduled_messages"]: logger.info(message) except SlackApiError as e: logger.error("Error creating conversation: {}".format(e)) list_scheduled_messages("1551991429", "2661991427")
    HTTP
    POST https://slack.com/api/chat.scheduledMessages.list
    Content-type: application/json
    Authorization: Bearer xoxb-your-token
    {
        "channel": "YOUR_CHANNEL_ID",
        "latest": 1551991429,
        "oldest": 1551991427,
    }

    Was this page helpful?