WhatsApp Business API by Wassenger

它列出的 54 个工具

“只读”和“会改数据”是服务方自己标的。带下划线的参数是必填的。

1. analyze_whatsapp_chat_messages

   WhatsApp chat message analysis tool. Supports delivery-status lookups and chat export. The 'device' parameter accepts a device ID (24-hex), phone number (E.164), or alias — auto-selected if the account has a single device; otherwise the tool errors with the list of available devices so you can ask the user. Available actions: - delivery_status: Check delivery and read receipts for specific outbound messages (≤30 days old) - export: Export chat messages in JSON, CSV, or TXT format

   action chat device fromDate toDate messageIds format includeMedia includeMetadata maxMessages

2. analyze_whatsapp_chats

   Reports and exports of the chats of a WhatsApp number. Available actions: - statistics: the team's figures for a period (7 days by default, up to 92): new, resolved and reopened chats, messages received and sent, internal notes, average time to the first reply, to each reply, to resolve and to handle a chat, what was in the inbox at the end of the period, the most used labels and a day-by-day breakdown. Add compareFromDate and compareToDate to compare with an earlier period and get the change in percent. Days are cut at midnight in the account timezone, so for whole days pass local midnights with their offset. Times are in seconds. There is no breakdown per agent or per hour. - export: Export chats in JSON, CSV or TXT, filtered by status and date, paging through as many chats as requested Use this tool for: weekly reports, response time reviews, backups, and feeding chat lists into another system.

   action device format limit status fromDate toDate compareFromDate compareToDate verbosity fields

3. create_whatsapp_template

   Create a WhatsApp message template and submit it to WhatsApp for review (WhatsApp Business API numbers only). It works in steps. Call it with whatever the user has given so far: if anything is missing or breaks a WhatsApp rule, it returns needsInput with the exact questions to ask, and nothing is created. When everything is valid it returns a preview and a confirmToken, still without creating anything. Show the preview; only after the user approves, call it again with the same fields plus the confirmToken. Supports text, image, video, document and location headers, body variables ({{1}} or {{first_name}}) with sample values, a footer, quick reply, URL, phone number and copy code buttons, and authentication (one-time code) templates.

   device name language category header body bodyExamples footer buttons authentication confirmToken

4. delete_whatsapp_file

   Delete an uploaded WhatsApp file permanently. This action cannot be undone and will remove the file from storage. The file will no longer be available for sending in messages.

   fileId

5. delete_whatsapp_template会改数据

   Delete one WhatsApp message template, in one language, from a WhatsApp Business API number. It works in two steps: called without a confirmToken it only reports which template would be deleted and returns a token, writing nothing; the deletion happens on a second call carrying that token, after the user approved it. It never deletes more than the template it reported, and it asks which language when the name exists in several.

   device name language confirmToken

6. download_whatsapp_chat_file

   Download the content of a received file from a WhatsApp chat. Returns the file content in the specified format: URL only (default) or base64 encoded content.

   device fileId outputFormat

7. download_whatsapp_file

   Download the content of an uploaded WhatsApp file. Returns the file content in the specified format: URL only (default) or base64 encoded content.

   fileId outputFormat

8. export_whatsapp_chats

   Export WhatsApp chats list in various formats for backup, analysis, or reporting purposes. Same as analyze_whatsapp_chats with action "export".

   device format limit status fromDate toDate compareFromDate compareToDate verbosity fields

9. get_whatsapp_archived_chats

   Retrieve archived WhatsApp chats. Useful for accessing historical conversations and managing chat organization. Same as get_whatsapp_chats with action "archived".

   device limit page sort fromDate toDate

10. get_whatsapp_assigned_chats

    Retrieve WhatsApp chats assigned to specific agents or departments. Essential for agent workload management and performance tracking. Same as get_whatsapp_chats with action "assigned".

    device agentId departmentId limit page sort

11. get_whatsapp_chat_by_id

    Retrieve detailed information about a specific chat using its WhatsApp ID. Includes complete metadata, assignment info, and activity details. Same as get_whatsapp_chats with action "by_id".

    device verbosity fields chat

12. get_whatsapp_chat_file_details

    Get detailed information about a specific received file from a WhatsApp chat by ID. Returns complete file metadata including sender information, chat context, media details, and download URLs.

    device fileId

13. get_whatsapp_chat_messages

    Retrieve WhatsApp chat messages (both inbound and outbound) for a specific device. Backed by the device-scoped Chat Messages endpoint, which requires a Platform subscription on the target device. Available actions: - recent: Latest messages in a chat (newest first by default) - search: Text search across messages (within a chat or device-wide) - date_range: Messages in a specific time window - by_sender: Messages sent from a specific phone number or WID - by_type: Messages filtered by type (text, image, video, audio, document, location, contact, etc.) - by_id: Fetch a specific message by its WhatsApp message ID - thread: Get conversation context around a specific message (N before + target + N after) - media: Messages containing media files The 'device' parameter accepts a device ID (24-hex), phone number in E.164 format, or device alias (e.g., "Sales 2") — pass exactly what the user named in their request. If the account has a single device, omit it and it will be auto-selected. If

    action chat device messageId limit includeMedia sortOrder query fromDate toDate sender messageTypes contextBefore contextAfter mediaTypes includeReactions includeQuotes includeFileDetails verbosity fields

14. get_whatsapp_chat_statistics

    Figures of the team for a period: chat and message volumes, response and resolution times, and what was in the inbox at the end of the period, optionally compared with an earlier period. Same as analyze_whatsapp_chats with action "statistics".

    device compareFromDate compareToDate fromDate toDate

15. get_whatsapp_chats

    Comprehensive WhatsApp chat retrieval tool supporting all chat operations through a unified action-based interface. Perfect for accessing chat lists, searching conversations, filtering by various criteria, and managing chat data. Supports all WhatsApp chat retrieval operations with consistent formatting. Available actions: - recent: Most recent chats - unread: Chats with unread messages - by_status: Filter by chat status (pending, active, resolved, archived...) - assigned: Chats assigned to an agent or department, or to anyone - unassigned: Chats nobody is handling yet - by_contact_type: Filter by chat type (chat, group, community, channel) - by_id: One chat by its WhatsApp ID - search: Free text search over phone, name, contact, company, metadata and private notes - archived: Archived chats - by_date_range: Chats by last message, first message or last inbound message date Every action accepts labels, labelsExclude, status and contactTypes as extra filters. To find leads that went qu

    action device limit page sort chatId status contactTypes agentId departmentId query labels labelsExclude fromDate toDate activityType verbosity fields

16. get_whatsapp_chats_by_contact_type

    Filter WhatsApp chats by contact type (individual users, groups, communities, channels). Useful for analyzing different communication patterns. Same as get_whatsapp_chats with action "by_contact_type".

    device contactTypes limit page sort

17. get_whatsapp_chats_by_date_range

    Retrieve WhatsApp chats that were active within a specific date range. Perfect for analyzing conversation patterns and generating reports. Same as get_whatsapp_chats with action "by_date_range".

    device fromDate toDate activityType limit page sort

18. get_whatsapp_chats_by_status

    Search and filter WhatsApp chats by their platform status (active, pending, resolved, etc.). Useful for workflow management and chat organization. Same as get_whatsapp_chats with action "by_status".

    device status limit page sort

19. get_whatsapp_device_details

    Retrieve comprehensive detailed information about a specific WhatsApp device using its ID. Returns complete device configuration, session status, metrics, and actionable insights. For WhatsApp Cloud API numbers it includes the health Meta reports: quality rating, messaging limit, payment problems, restrictions and the issues Meta lists with their fix. Use it to find out why messages are not going out.

    deviceId includeSettings includeSessionLogs includeMetrics

20. get_whatsapp_devices

    Comprehensive tool to retrieve WhatsApp devices with flexible filtering options. Supports all device query scenarios: get all devices, filter by status/session status, search by terms, get only active/online devices, etc.

    status sessionStatus search exactMatch onlineOnly activeOnly minUptime limit page includeMetrics includeSettings includeSessionDetails includeSessionLogs

21. get_whatsapp_file_details

    Get detailed information about a specific uploaded WhatsApp file by ID. Returns complete file metadata including size, type, format, status, expiration, tags, and download URLs.

    fileId

22. get_whatsapp_unread_chats

    Retrieve WhatsApp chats with unread messages. Essential for managing pending conversations and customer support. Same as get_whatsapp_chats with action "unread".

    device limit page sort labels

23. health_check

    Comprehensive health check of the MCP server and connected WhatsApp devices.

24. list_whatsapp_flow_responses只读

    List what customers answered in a WhatsApp Form (Meta WhatsApp Flow), newest first: who answered, each question's label and value, and when. Takes the form's id from list_whatsapp_flows (not its flowId). Only keys of the account owner or an admin can read answers.

    form_id from to campaign device page size

25. list_whatsapp_flows只读

    List WhatsApp Flows available for a device (WABA). Returns flow id, name, status, categories and entry screen. Use this to find a flow to send.

    device status

26. list_whatsapp_templates只读

    Retrieve WhatsApp templates for a specific device (approved ones by default). Each template includes its components and the variables that must be filled in to send it. This is required for sending template-based messages.

    device status size

27. manage_whatsapp_campaign_contacts

    Universal WhatsApp campaign contacts management tool that handles all campaign recipient operations through action-based parameters. Supports add, remove, and search operations for campaign recipients: phone numbers and groups. Essential for WhatsApp campaign recipient management. add keeps the recipients already on the campaign. On a campaign that sends a template (WhatsApp Cloud API numbers), give every variable its component exactly as on manage_whatsapp_campaigns create: body, header, header_location, button_url_N or button_copy_code_N, with N the buttonIndex that list_whatsapp_templates reports. Such a campaign only reaches phone numbers, not groups. On a campaign from a number linked by QR, each variable key fills the {{ key }} placeholder of the campaign message.

    campaignId action search target kind status page size contacts phones groups channels wids

28. manage_whatsapp_campaigns

    Universal WhatsApp campaign management tool that handles all campaign operations through action-based parameters. Supports search, create, update, start, stop, and delete operations for WhatsApp bulk messaging campaigns. Perfect for comprehensive WhatsApp marketing automation. What a campaign sends depends on the number. Its connector, reported by get_whatsapp_devices and health_check, says which kind it is: cloud for WhatsApp Cloud API, web for a number linked by QR. - WhatsApp Cloud API (WABA) numbers: a pre-approved template is required, and it only reaches phone numbers, never groups. Pass template { name, language } and give each recipient the values its variables need. Read the template first with list_whatsapp_templates: every variable it reports has a location (header, body or buttons) and, for buttons, a buttonIndex starting at 0. Send each value with its component, and for a button variable use button_url_N or button_copy_code_N with that index. - Numbers linked by QR: a mes

    device action before after status owner phone group page size campaignId name message template file settings contacts unsubscribe activate confirmPaymentIssue costs

29. manage_whatsapp_channel_messages

    Comprehensive WhatsApp channel message management tool for retrieving and managing channel content. Perfect for monitoring channel activity and accessing channel message history. Available actions: - get: Get recent messages from a specific channel with filtering options

    device action channelId limit includeMedia includeDeleted page sortOrder fromDate toDate messageTypes

30. manage_whatsapp_channels

    Comprehensive WhatsApp channel management tool supporting all channel operations. Perfect for managing channel lifecycle, membership, and content. Supports all WhatsApp channel operations through a unified action-based interface. Available actions: - list: List and retrieve channels with filtering options - get: Get detailed information about a specific channel - create: Create new channels with optional profile images - update: Update existing channel information (name, description) - search: Search for public channels by category and keywords - join: Join/follow channels via invite code or URL - leave: Leave/unfollow channels - delete: Delete channels (alias for leave) - update_image: Update channel profile images

    device action channelId limit page permission include sort searchQuery category sortOrder sortField countries name description uploadImage imageSource imageUrl imageData joinMethod inviteCode inviteUrl

31. manage_whatsapp_chat

    Change a WhatsApp chat in the team inbox without sending anything to the customer: hand it to a teammate or department, add or remove labels, resolve or reopen it, leave an internal note, or mark it read or unread. The customer sees none of it. Your team sees the change, and your account's chat webhooks are notified. Available actions: - assign: give the chat to agentId, agentEmail or departmentId (departments need a plan that includes them). A pending chat becomes active. - unassign: take the chat off its agent and department. It goes back to pending. - add_labels / remove_labels: the labels must already exist on the number, create them first with manage_whatsapp_labels. The chat keeps any label you do not mention. - resolve: close the conversation. - reopen: back to active if someone owns the chat, pending otherwise. - add_note: private note only your team can see (2 to 6000 characters). authorId writes it as that teammate. - mark_read / mark_unread: marking a resolved chat as unrea

    action device chat agentId agentEmail departmentId labels note authorId

32. manage_whatsapp_contact_actions

    Manage WhatsApp contact blocking and unblocking operations. Handle contact blocking status with action-based operations to control message reception from specific contacts. Contacts are identified by phone number in E.164 format, not by WhatsApp ID.

    action device contacts

33. manage_whatsapp_contacts

    Comprehensive WhatsApp contacts management with action-based operations. Supports listing, searching, creating, updating, deleting contacts, bulk operations, and metadata management. All contact operations including CRUD, filtering, pagination, and metadata handling in one unified tool.

    action device contactWid limit page search type status owner phone wid metadataKey metadataValue after before updatedAfter updatedBefore include sort verbosity fields name surname title kind gender altPhone email description birthday timezone address city postalCode country currency notes companyName companyCode companyTaxId

34. manage_whatsapp_deal_notes

    Comprehensive WhatsApp deal note management tool supporting all note operations. A note is what somebody wrote on a sales deal; a note that carries a due date IS a task. Perfect for managing sales notes, tracking tasks, and attaching files to deals. Supports both standalone notes and comments nested under deal history events. Available actions: - list: Retrieve all notes for a deal with filtering and metadata - create: Create a new note (optionally as a task with due date, or as a comment on a deal event) - update: Update note text, due date, completion status, or file attachments - delete: Remove a note (requires confirmation) Note: The Sales Funnel API is available on the Platform Professional subscription and above. Write endpoints return HTTP 403 when the account's plan does not include it; read endpoints are deliberately NOT plan-gated. Restricted agents (plain agent role) only ever receive their own deals, regardless of filters.

    action dealId noteId text dueAt done event files limit skip confirmDeletion

35. manage_whatsapp_deals

    Comprehensive WhatsApp sales funnel deal management tool. A deal is one sales opportunity tied to a WhatsApp contact, sitting in one stage of one pipeline. Supports listing, retrieving, creating, updating, archiving, moving between stages, linking to chats, and fetching event history. Available actions: - list: Retrieve deals with rich filtering (pipeline, stage, status, agent, contact, device, stalled, chatStatus, unread, updatedAfter/Before, pagination) - get: Retrieve a single deal by ID - create: Create a new deal (requires pipeline, device, contactWid) - update: Update deal fields (title, amount, currency, agent, department) - stage moves are NOT here, use move_stage - archive: Archive a deal (frees the contact's open-deal slot, preserves as sales history) - move_stage: Move a deal to another stage (requires previousStage for atomic compare-and-swap) - link_chat: Link a deal to a WhatsApp conversation by contactWid - events: Fetch deal event history (limit, skip) Important notes

    action dealId pipeline stage status agent unassigned contact device stalled updatedAfter updatedBefore chatStatus unread page size contactWid chatWid title amount currency department card previousStage lostReason limit skip confirmDeletion

36. manage_whatsapp_departments

    Comprehensive WhatsApp department management tool supporting all department operations. Perfect for organizing team structure, managing agent assignments, and customizing department appearance. Supports all WhatsApp department operations through a unified action-based interface. Available actions: - list: List and retrieve all departments with complete information - create: Create new departments with agents, colors, and icons - update: Update existing department information and agent assignments - delete: Delete departments (removes department but preserves agent assignments)

    device action departmentId name color icon description agents

37. manage_whatsapp_group_participants

    Universal WhatsApp group participants management tool that handles all participant operations through action-based parameters. Supports add, remove, promote, demote, and approval management operations. Essential for WhatsApp group moderation.

    device groupId action participants phones all

38. manage_whatsapp_groups

    Universal WhatsApp group management tool that handles all group operations through action-based parameters. Supports search, create, update, join, leave, and invite management operations. Perfect for comprehensive WhatsApp group administration.

    device action kind page size search status include sort groupId name description participants permissions ephemeral code url remove

39. manage_whatsapp_labels

    Comprehensive WhatsApp label management tool supporting all label operations. Perfect for organizing conversations with color-coded categories and managing chat organization systems. Supports both WhatsApp Business and platform-specific labels. Available actions: - list: Retrieve all available labels with filtering and metadata - create: Create new labels with custom colors and descriptions - update: Update existing label colors and descriptions - delete: Remove labels and cleanup associated chats

    device action name includeMetadata filterByScope activeOnly color description confirmDeletion

40. manage_whatsapp_message_interactions

    Manage WhatsApp message interactions including replies, forwards, reactions, and poll voting. Handle all message interaction operations with action-based approach for comprehensive message engagement functionality.

    action chat message quote selectId forward reaction reactionMessage vote device agent reference idempotencyKey

41. manage_whatsapp_pipelines

    Comprehensive sales pipeline management tool for the WhatsApp sales funnel (CRM). A pipeline is a sales board: an ordered list of stages that deals move through, optionally fed by specific WhatsApp numbers. Use it to set up sales boards, inspect their configuration and read their headline numbers. Available actions: - list: Retrieve all sales pipelines of the account, optionally only those fed by one device - get: Retrieve a single pipeline with its full stage configuration - create: Create a new pipeline with stages, entry rules and behaviour settings - update: Update pipeline properties, stages, lost reasons or settings - delete: Remove a pipeline (refused with 409 while it still holds open deals) - summary: Per-stage deal counts and open amount totals for the board, plus won and lost totals for the last 30 days Stage ordering matters: a pipeline requires at least one open, one won and one lost stage, and the won and lost stages must come AFTER all the open ones, because a deal adv

    action pipelineId device name description color icon devices currency entry stages lostReasons settings confirmDeletion

42. manage_whatsapp_queue

    Comprehensive WhatsApp queue management tool supporting all queue operations. Perfect for monitoring queue health, controlling message delivery flow, and performing bulk message operations. Supports all WhatsApp queue operations through a unified action-based interface. Available actions: - get_status: Get comprehensive queue statistics and status information - update_status: Update queue processing status (pause/active/reject/freeze) with optional force delivery - delete_messages: Delete queued messages with flexible filtering options. A call with no messageIds, phoneNumbers, groupIds or dateRange would delete every queued and scheduled message, so it is refused unless confirmEmptyQueue is true

    device action status force filters waitForCompletion confirmEmptyQueue

43. manage_whatsapp_status

    Comprehensive WhatsApp status management tool supporting all status operations. Perfect for managing status lifecycle, publishing immediate or scheduled content, and retrieving status history. Supports all WhatsApp status operations through a unified action-based interface. Available actions: - get: Search and retrieve status history with comprehensive filtering - publish: Publish immediate status updates with text, images, or videos - schedule: Schedule status updates for future publishing with advanced timing

    action device flow mine scheduled search chat phone reference type ack wid fromDate toDate sortOrder limit page message media font color schedule order idempotencyKey scheduleType delay delayTo publishDate strictOrder timezone

44. manage_whatsapp_team

    Comprehensive WhatsApp team management tool supporting all team operations. Perfect for managing team member lifecycle, device access, and role assignments. Supports all WhatsApp team operations through a unified action-based interface. Available actions: - search: Search and list team members with filtering options - get: Get detailed information about a specific team member by ID - create: Create a new team member and grant them access to a WhatsApp device (requires device, email, displayName, password, role and color) - update: Update an existing team member's name, email, password, role or color - delete: Delete one or more team members from the account, choosing what happens to their assigned chats - grant_access: Grant an existing team member access to a WhatsApp device - revoke_access: Revoke a team member's access to a WhatsApp device, choosing what happens to their assigned chats Notes: - New team members are always created against a specific WhatsApp device and are granted

    action userId userIds email device query role status ids exceptIds loginBefore loginAfter onlineBefore onlineAfter page size displayName password color invite chatAction reassignTo force remove

45. ping

    Basic ping test to check MCP server connectivity and response time. Returns server status and timestamp.

    message

46. search_whatsapp_chat_files

    Search and list received files from WhatsApp chats (inbound files). These are media files that were sent to your WhatsApp number by other users. Supports filtering by chat, file type, date range, and more.

    device search type chat flow after before page size sort

47. search_whatsapp_chats_by_name

    Search for WhatsApp chats by contact name, group name, phone number, company, metadata or private notes. Perfect for quickly finding specific conversations. Same as get_whatsapp_chats with action "search".

    device query contactTypes limit page

48. search_whatsapp_outbound_files

    Search and list uploaded WhatsApp files with advanced filtering. Returns outbound files that have been uploaded to the platform for sending as media messages. Supports extensive filtering by filename, file type, size, creation date, tags, and more.

    search filename format mime kind ext tags status permission origin after before minSize maxSize page size

49. send_whatsapp_flow

    Send a published WhatsApp Form (Meta WhatsApp Flow) to a chat as a native interactive message: one message instead of asking question after question. Only works within the 24h customer-service window; to start a conversation, send a template whose button opens the form. Pass a token to match the answers to your own record (it comes back in the message:flow:response webhook), and data to prefill the form.

    device phone flow_id cta body screen token data header footer idempotencyKey

50. send_whatsapp_message

    Comprehensive WhatsApp message sending with action-based operations. Supports all message types including text, media, location, contact, poll, event messages, with scheduling, live delivery, expiration, agent messaging, and template support. All message sending operations unified in one tool. Scheduling: pass exactly one of deliverAt, delay or delayTo on the text, media, template, agent or scheduled actions. Leaving all three out sends the message right away. On WhatsApp Cloud API (WABA) numbers a plain text, media or agent message still needs the customer to have written within the last 24 hours at delivery time, so a reminder that lands later than that must use the template action.

    action chat device message previewUrl deliverAt delay delayTo media location contacts poll event enqueue expiration agentId actions template order agent reference sendReadAck idempotencyKey

51. update_whatsapp_file_metadata

    Update metadata and properties of an uploaded WhatsApp file. You can modify filename, tags, expiration time, access permissions, format, and reference ID to better organize and manage your files.

    fileId filename reference format tags message expiration permission

52. upload_whatsapp_file_from_url

    Upload a file from a remote URL to the WhatsApp platform for use in media messages. The file will be downloaded from the provided URL and stored securely. Returns the uploaded file details including ID for use in message sending.

    url filename format expiration permission reference tags

53. validatePhoneNumbers只读

    Validates the format of given phone numbers according to E.164 standard and checks their potential validity. Can validate up to 500 phone numbers at once.

    phoneNumbers

54. verifyWhatsAppNumberExists

    Checks if a given phone number is associated with an active WhatsApp account.

    phoneNumber