CheckMessageInput

object

contact_id: Id
Opaque record id.
lead_id: Id
Opaque record id.
channel: "whatsapp_cloud" | "whatsapp_web" | "sms" | "email" | "auto"
purposerequired: MessagePurpose
transactional: OTPs, receipts (not subject to consent) · service: visit reminders, documents (unless opted out) · promotional: launches, matches, price drops (consent or the TRAI 7-day enquiry window, quiet hours, DND).
template_id: Id
Opaque record id.
template_use_case: string
e.g. visit_reminder_24h
language: string
body: string
media: SendMessageMedia
One photo, video, voice note or document; the body becomes its caption (not for voice notes).
interactive: object or object
Reply buttons (≤ 3, title ≤ 20) or a list (≤ 10 rows, title ≤ 24, description ≤ 72) under `body` — WhatsApp Cloud only, inside the 24-hour window; no template or media.
subject: string
vars: map of string
property_id: Id
Opaque record id.
project_id: Id
Opaque record id.
visit_id: Id
Opaque record id.
channel_account_id: Id
Opaque record id.
conversation_id: Id
The conversation being answered: a WhatsApp reply goes to its number and account.
reply_to_message_id: Id
Opaque record id.
when_quiet: "block" | "defer"

Example

{
  "contact_id": "cmusrceel0000q7kaafxqi1om",
  "lead_id": "cmusrceel0000q7kaafxqi1om",
  "channel": "auto",
  "purpose": "transactional",
  "template_id": "cmusrceel0000q7kaafxqi1om",
  "template_use_case": "string",
  "language": "string",
  "body": "string",
  "media": {
    "storage_key": "string",
    "url": "https://example.com",
    "mime": "image/jpeg",
    "filename": "string",
    "size": 0
  },
  "interactive": {
    "type": "buttons",
    "header": "string",
    "footer": "string",
    "buttons": [
      {
        "id": "string",
        "title": "string"
      }
    ]
  },
  "subject": "string",
  "vars": {},
  "property_id": "cmusrceel0000q7kaafxqi1om",
  "project_id": "cmusrceel0000q7kaafxqi1om",
  "visit_id": "cmusrceel0000q7kaafxqi1om",
  "channel_account_id": "cmusrceel0000q7kaafxqi1om",
  "conversation_id": "cmusrceel0000q7kaafxqi1om",
  "reply_to_message_id": "cmusrceel0000q7kaafxqi1om",
  "when_quiet": "block"
}

{ "contact_id": "cmusrceel0000q7kaafxqi1om", "lead_id": "cmusrceel0000q7kaafxqi1om", "channel": "auto", "purpose": "transactional", "template_id": "cmusrceel0000q7kaafxqi1om", "template_use_case": "string", "language": "string", "body": "string", "media": { "storage_key": "string", "url": "https://example.com", "mime": "image/jpeg", "filename": "string", "size": 0 }, "interactive": { "type": "buttons", "header": "string", "footer": "string", "buttons": [ { "id": "string", "title": "string" } ] }, "subject": "string", "vars": {}, "property_id": "cmusrceel0000q7kaafxqi1om", "project_id": "cmusrceel0000q7kaafxqi1om", "visit_id": "cmusrceel0000q7kaafxqi1om", "channel_account_id": "cmusrceel0000q7kaafxqi1om", "conversation_id": "cmusrceel0000q7kaafxqi1om", "reply_to_message_id": "cmusrceel0000q7kaafxqi1om", "when_quiet": "block" }