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",
"waMessageKey": {
"fromMe": true,
"remote": "string",
"id": "string",
"_serialized": "string",
"participant": "string"
},
"to": "string",
"recipientName": "string",
"type": "text",
"text": "string",
"mediaUrl": "string",
"mediaKind": "image",
"pollQuestion": "string",
"pollOptions": [
"string"
],
"pollAllowMultiple": true,
"status": "pending",
"sendAt": "2019-08-24T14:15:22Z",
"recurrence": {
"frequency": "daily",
"interval": 0,
"byWeekday": [
"MO"
],
"endsAfter": 0,
"endsOn": "2019-08-24T14:15:22Z",
"timezone": "string"
},
"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",
"secret": "string",
"linkPreview": {
"title": "string",
"description": "string",
"canonicalUrl": "string",
"thumbnail": "string"
},
"waLabels": {
"requested": 0,
"applied": true,
"error": "string"
},
"warning": {
"code": "no_engine_connected",
"message": "string"
}
}
],
"answeredBy": {
"engineId": "string",
"numberId": "string",
"phoneNumber": "string"
},
"limit": 0,
"skip": 0,
"total": 0,
"nextCursor": "string"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"request_id": "string",
"requestId": "string",
"details": [
{
"path": "string",
"code": "string",
"message": "string"
}
],
"candidates": [
{
"numberId": "string",
"phoneNumber": "string"
}
],
"upgrade": {
"url": "string",
"text": "string",
"reset_time": "string",
"seconds_remaining": 0,
"plan": {}
}
}
}Query Parameters
Filter to messages addressed to this chat. Accepts +E164 / bare digits / any WhatsApp id; normalized to <phone>@c.us to match the recipient stored on the queued/scheduled doc.
Search token; when set, only items whose name matches are returned.
1 <= length <= 200Filter by lifecycle status: pending (accepted, waiting), confirmed (WhatsApp accepted — has waMessageKey), received (double grey tick), read (double blue tick), played (voice played), failed.
"pending" | "before-wa-send" | "bt-sent" | "sending" | "sent" | "sent_pending_ack" | "confirmed" | "delivered" | "received" | "read" | "played" | "cancelled" | "error" | "failed" | "expired"Include messages that were already SENT and therefore soft-deleted (default false). A cancelled message is never included. Pair with chatId to answer "what has this contact already been sent?".
falseInclude the link-preview thumbnail image (default false). Title, description and url are always returned; only the embedded image is omitted.
falseSort direction by timestamp: asc (oldest first) or desc (newest first, default).
"desc""asc" | "desc"Number of items to skip before the page (default 0).
00 <= valuePage size (1-200, default 50).
501 <= value <= 200Response
Response Body
application/json
application/json