GEgetstream
product:chat

Query scheduled messages

Changed on

Lists the scheduled messages of one user across channels: pending ones first, then failed ones, each by scheduled_at. Client-side requests return the caller's own; server-side requests require user_id

post/scheduled_messages/query

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/scheduled_messages/query
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Request body

limitinteger

Page size, 1 to 100. Defaults to 20

nextstring

Cursor from the previous page

user_idstring

Response

Successful response

durationstring required

Duration of the request in milliseconds

nextstring

Cursor for the next page; empty on the last page

Changes