cancel_scheduled_message
Cancels scheduled messages before they are sent. Pass id to cancel that message; if it repeats, the whole series is cancelled (any of the series' ids works). Messages already sent, or being sent right now, can't be cancelled; the result says so. Find ids with list_scheduled_messages (filter by to or text). To change a scheduled message, cancel it and schedule it again with schedule_message. Confirm with the user first unless they asked for it. Works on the free plan too. Returns { cancelled, messages }, the cancelled messages { id, series_id (shared by every send of a repeating message), status (scheduled, processing, sent, failed, missed or cancelled), recipient (contact fields (name; name_source: address_book, push_name, group_subject, business, phone or unresolved; canonical_jid: the JID to pass to send_message and read_chat_history; phone_jid and lid_jid: the chat's phone-number and LID forms, null when unknown or for groups; phone_display: the number as +).), text?, media?, send_at (UTC), send_at_local, when (readable local time and how far away), timezone, recurrence, occurrence? (0 = first send of a series), until?, sent_at?, message_id? (once sent), error? (why it failed or was missed) }.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | A scheduled message's id. Cancels it and, if it repeats, every later send. |