List scheduled messages | Sample

6 parameters

channelstringoptional

The channel whose scheduled messages to list.

latestnumberoptional

UNIX timestamp defining the latest point in the time range.

oldestnumberoptional

UNIX timestamp defining the earliest point in the time range.

limitintegeroptional

The maximum number of original entries to return.

cursorstringoptional

Pagination cursor from a previous response's `response_metadata.next_cursor` value.

tokenstringoptional

Authentication token with the `none` scope.

2 status codes

200Returns an array of scheduled messages and `response_metadata` containing the next pagination cursor.

okbooleanrequired

Allowed:true

response_metadataobjectrequired

scheduled_messagesarray<object>required

defaultReturned when the supplied channel or another request argument is invalid.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:invalid_channelnot_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requiredekm_access_deniedmissing_scopeinvalid_argumentsinvalid_arg_nameinvalid_charset

okbooleanrequired

Allowed:false

Error handling

latest and oldest must be UNIX timestamps when supplied. Use the cursor returned in response_metadata.next_cursor to continue pagination, and provide a valid channel identifier when filtering by channel.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.chatScheduledMessagesList.list({
  channel: "example",
  latest: "example",
  oldest: "example",
  limit: 20,
  cursor: "example",
});

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

Request

Response

Errors