Scheduled Messages
List scheduled messages
List messages in the user-messages queue (all sources: API, dashboard, extension), newest first (offset-paginated).
Optionally filter by chatId and/or lifecycle status.
Request
curl -X GET "https://api.blueticks.co/v1/scheduled-messages"{
"success": true,
"data": [
{
"id": "string",
"key": "string",
"to": "string",
"type": "text",
"text": "string",
"mediaUrl": "string",
"mediaKind": "image",
"pollQuestion": "string",
"status": "pending",
"sendAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"confirmedAt": "2019-08-24T14:15:22Z",
"receivedAt": "2019-08-24T14:15:22Z",
"readAt": "2019-08-24T14:15:22Z",
"playedAt": "2019-08-24T14:15:22Z",
"failedAt": "2019-08-24T14:15:22Z",
"failureReason": "string",
"linkPreview": {
"title": "string",
"description": "string",
"canonicalUrl": "string",
"thumbnail": "string"
}
}
],
"limit": 0,
"skip": 0,
"total": 0
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"request_id": "string",
"details": [
{
"path": "string",
"code": "string",
"message": "string"
}
]
}
}Query Parameters
chatId?string
Filter to messages addressed to this WhatsApp JID. Matches the recipient stored on the queued/scheduled doc — for sends to a phone number, the JID is <phone>@c.us.
Match
^[0-9]+(?:-[0-9]+)?@(?:c\.us|g\.us|newsletter)$searchToken?string
Search token; when set, only items whose name matches are returned.
Length
1 <= length <= 200status?string
Filter by lifecycle status: pending (accepted, waiting), confirmed (WhatsApp accepted — has waMessageKey), received (double grey tick), read (double blue tick), played (voice played), failed.
Value in
"pending" | "confirmed" | "received" | "read" | "played" | "failed"skip?integer
Number of items to skip before the page (default 0).
Default
0Range
0 <= valuelimit?integer
Page size (1-200, default 50).
Default
50Range
1 <= value <= 200Response
Response Body
application/json
application/json