Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 | // WhatsApp Cloud API Type Definitions
// Covers outbound messages, inbound webhooks, template management, and queue messages.
// === Outbound Message Types ===
export type WhatsAppMessageType =
| "text"
| "template"
| "interactive"
| "image"
| "video"
| "document"
| "audio"
| "location";
export type WhatsAppTextPayload = {
messaging_product: "whatsapp";
to: string;
type: "text";
text: { body: string; preview_url?: boolean };
};
export type WhatsAppTemplateComponent = {
type: "header" | "body" | "button";
sub_type?: "quick_reply" | "url";
index?: number;
parameters: WhatsAppTemplateParameter[];
};
export type WhatsAppTemplateParameter =
| { type: "text"; text: string }
| { type: "image"; image: { link: string } }
| { type: "video"; video: { link: string } }
| { type: "document"; document: { link: string; filename?: string } }
| { type: "payload"; payload: string }
| {
type: "currency";
currency: { fallback_value: string; code: string; amount_1000: number };
}
| { type: "date_time"; date_time: { fallback_value: string } };
export type WhatsAppTemplatePayload = {
messaging_product: "whatsapp";
to: string;
type: "template";
template: {
name: string;
language: { code: string; policy?: "deterministic" };
components?: WhatsAppTemplateComponent[];
};
};
export type WhatsAppInteractiveButton = {
type: "reply";
reply: { id: string; title: string };
};
export type WhatsAppInteractivePayload = {
messaging_product: "whatsapp";
to: string;
type: "interactive";
interactive: {
type: "button" | "list";
header?: { type: "text"; text: string };
body: { text: string };
footer?: { text: string };
action: {
buttons?: WhatsAppInteractiveButton[];
button?: string;
sections?: Array<{
title: string;
rows: Array<{ id: string; title: string; description?: string }>;
}>;
};
};
};
export type WhatsAppMediaPayload = {
messaging_product: "whatsapp";
to: string;
type: "image" | "video" | "document" | "audio";
image?: { link: string; caption?: string };
video?: { link: string; caption?: string };
document?: { link: string; caption?: string; filename?: string };
audio?: { link: string };
};
export type WhatsAppMarkReadPayload = {
messaging_product: "whatsapp";
status: "read";
message_id: string;
};
export type WhatsAppOutboundPayload =
| WhatsAppTextPayload
| WhatsAppTemplatePayload
| WhatsAppInteractivePayload
| WhatsAppMediaPayload
| WhatsAppMarkReadPayload;
// === Send API Response ===
export type WhatsAppSendResponse = {
messaging_product: "whatsapp";
contacts: Array<{ input: string; wa_id: string }>;
messages: Array<{ id: string; message_status?: string }>;
};
export type WhatsAppApiErrorResponse = {
error: {
message: string;
type: string;
code: number;
error_subcode?: number;
fbtrace_id?: string;
};
};
// === Inbound Webhook Types ===
export type WhatsAppWebhookPayload = {
object: "whatsapp_business_account";
entry: WhatsAppWebhookEntry[];
};
export type WhatsAppWebhookEntry = {
id: string;
changes: WhatsAppWebhookChange[];
};
export type WhatsAppWebhookChange = {
field: "messages" | "message_template_status_update";
value: WhatsAppWebhookValue & Partial<WhatsAppTemplateStatusWebhook>;
};
export type WhatsAppWebhookValue = {
messaging_product: "whatsapp";
metadata: {
display_phone_number: string;
phone_number_id: string;
};
contacts?: Array<{
profile: { name: string };
wa_id: string;
}>;
messages?: WhatsAppInboundMessage[];
statuses?: WhatsAppStatusUpdate[];
};
export type WhatsAppInboundMessage = {
id: string;
from: string;
timestamp: string;
type: WhatsAppMessageType;
text?: { body: string };
image?: WhatsAppMediaInfo;
video?: WhatsAppMediaInfo;
document?: WhatsAppMediaInfo & { filename?: string };
audio?: WhatsAppMediaInfo;
interactive?: {
type: "button_reply" | "list_reply";
button_reply?: { id: string; title: string };
list_reply?: { id: string; title: string; description?: string };
};
location?: {
latitude: number;
longitude: number;
name?: string;
address?: string;
};
};
export type WhatsAppMediaInfo = {
id: string;
mime_type: string;
sha256: string;
caption?: string;
};
export type WhatsAppStatusUpdate = {
id: string;
recipient_id: string;
status: "sent" | "delivered" | "read" | "failed";
timestamp: string;
errors?: Array<{ code: number; title: string; message?: string }>;
conversation?: {
id: string;
origin: {
type:
| "business_initiated"
| "user_initiated"
| "referral_conversion";
};
};
pricing?: {
billable: boolean;
pricing_model: string;
category: string;
};
};
// === Template Management Types ===
export type WhatsAppTemplateCategory =
| "MARKETING"
| "UTILITY"
| "AUTHENTICATION";
export type WhatsAppTemplateStatus =
| "APPROVED"
| "PENDING"
| "REJECTED"
| "PAUSED"
| "DISABLED";
export type WhatsAppTemplateComponentDef = {
type: "HEADER" | "BODY" | "FOOTER" | "BUTTONS";
format?: "TEXT" | "IMAGE" | "VIDEO" | "DOCUMENT" | "LOCATION";
text?: string;
buttons?: Array<{
type: "QUICK_REPLY" | "URL" | "PHONE_NUMBER" | "COPY_CODE";
text: string;
url?: string;
phone_number?: string;
}>;
};
export type WhatsAppTemplateCreateRequest = {
name: string;
language: string;
category: WhatsAppTemplateCategory;
components: WhatsAppTemplateComponentDef[];
};
export type WhatsAppTemplateFromMeta = {
id: string;
name: string;
language: string;
category: WhatsAppTemplateCategory;
status: WhatsAppTemplateStatus;
components: WhatsAppTemplateComponentDef[];
rejected_reason?: string;
};
export type WhatsAppTemplateListResponse = {
data: WhatsAppTemplateFromMeta[];
paging?: {
cursors: { before: string; after: string };
next?: string;
};
};
// === Template Status Webhook ===
export type WhatsAppTemplateStatusWebhook = {
event:
| "APPROVED"
| "REJECTED"
| "PENDING_DELETION"
| "DISABLED"
| "PAUSED"
| "IN_APPEAL";
message_template_id: number;
message_template_name: string;
message_template_language: string;
reason?: string;
};
// === Queue Message Type ===
export type WhatsAppQueueMessage = {
type: "campaign_send" | "reply";
campaignId?: number;
recipientId?: number;
conversationId?: number;
phone: string;
payload: WhatsAppOutboundPayload;
metadata?: Record<string, unknown>;
};
|