NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

WhatsApp

whatsapp

Enables interaction with customers through the WhatsApp Business API for messaging and automation. Only supports WhatsApp Business accounts, not WhatsApp Personal accounts.

Phone & SMSCommunicationWeb del proveedor
Acciones
19
Triggers
1
Autenticación
—
OAuth gestionado
Sí
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (19)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create message templateWHATSAPP_CREATE_MESSAGE_TEMPLATEAcción

Create a new message template for the whatsapp business account. templates must be approved by whatsapp before they can be used. templates are required for marketing messages and messages sent outside the 24-hour window.

Parámetros de entrada

  • namestringObligatorio

    Template name (lowercase, alphanumeric, underscores, max 512 characters).

  • categorystringObligatorioenum

    Template category: AUTHENTICATION, MARKETING, or UTILITY.

    AUTHENTICATIONMARKETINGUTILITY
  • languagestringObligatorio

    Language code (e.g., 'en_US', 'es_ES').

  • componentsobject[]Obligatorio

    Template components (header, body, footer, buttons).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete message templateWHATSAPP_DELETE_MESSAGE_TEMPLATEAcción

Delete a message template from the whatsapp business account. this permanently removes the template and it cannot be recovered. only delete templates that are no longer needed.

Parámetros de entrada

  • template_idstringObligatorio

    The ID of the template to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get business profileWHATSAPP_GET_BUSINESS_PROFILEAcción

Get the business profile information for a whatsapp business phone number. this includes business details like description, address, website, and contact info.

Parámetros de entrada

  • fieldsstring

    Comma-separated list of fields to retrieve. Default includes all available fields.

  • phone_number_idstringObligatorio

    The phone number ID to get the business profile for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get mediaWHATSAPP_GET_MEDIAAcción

Get information about uploaded media including a temporary download url. the download url is valid for 5 minutes and can be used to retrieve the actual media file. this is useful for downloading media that was sent to your whatsapp number.

Parámetros de entrada

  • media_idstringObligatorio

    The media ID to retrieve information for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get media infoWHATSAPP_GET_MEDIA_INFOAcción

Get metadata about uploaded media without generating a download url. this is useful for checking file size, type, and hash without downloading the file. use get media if you need the actual download url.

Parámetros de entrada

  • media_idstringObligatorio

    The media ID to get information for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get message templatesWHATSAPP_GET_MESSAGE_TEMPLATESAcción

Get all message templates for the whatsapp business account. templates are required for sending messages outside the 24-hour window and for marketing/utility messages.

Parámetros de entrada

  • afterstring

    Cursor for pagination to get templates after this cursor.

  • limitinteger

    The maximum number of templates to retrieve. Default is 25.

  • statusstring

    Filter by template status: APPROVED, PENDING, REJECTED, DISABLED, PAUSED, LIMIT_EXCEEDED.

  • categorystring

    Filter by template category: AUTHENTICATION, MARKETING, UTILITY.

  • languagestring

    Filter by language code (e.g., 'en_US', 'es_ES').

  • name_or_contentstring

    Filter templates by name or content substring.

Parámetros de salida

  • dataobject[]

    List of message templates.

  • errorstring

    Error if any occurred during the execution of the action

  • pagingobject

    Paging information for pagination.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get phone numberWHATSAPP_GET_PHONE_NUMBERAcción

Get details of a specific phone number associated with a whatsapp business account.

Parámetros de entrada

  • fieldsstring

    Comma-separated list of fields to retrieve. Default includes all available fields.

  • phone_number_idstringObligatorio

    The phone number ID to get details for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get phone numbersWHATSAPP_GET_PHONE_NUMBERSAcción

Get all phone numbers associated with a whatsapp business account (waba).

Parámetros de entrada

  • limitinteger

    The maximum number of phone numbers to retrieve. Default is 25.

Parámetros de salida

  • dataobject[]

    List of phone numbers associated with the WABA.

  • errorstring

    Error if any occurred during the execution of the action

  • pagingobject

    Paging information for pagination.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get template statusWHATSAPP_GET_TEMPLATE_STATUSAcción

Get the status and details of a specific message template. this is useful for checking if a template has been approved, rejected, or is still pending review.

Parámetros de entrada

  • fieldsstring

    Comma-separated list of fields to retrieve.

  • template_idstringObligatorio

    The ID of the template to check the status for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send contactsWHATSAPP_SEND_CONTACTSAcción

Send contacts whatsapp number. note: the message will be delivered to the recipient only if they have initiated a conversation first.

Parámetros de entrada

  • contactsobject[]Obligatorio

    List of contacts to send. Sample input: [ { 'addresses': [ { 'city': 'city name', 'country': 'country name', 'country_code': 'code', 'state': "Contact's State", 'street': "Contact's Street", 'type': "Contact's Address Type", 'zip': "Contact's Zip Code" } ], 'birthday': 'birthday', 'emails': [ {'email': 'email', 'type': 'HOME'}, {'email': 'email', 'type': 'WORK'} ], 'name': { 'first_name': 'first name value', 'formatted_name': 'formatted name value', 'last_name': 'last name value', 'suffix': 'suffix value' }, 'org': { 'company': 'company name', 'department': 'dep name', 'title': 'title' }, 'phones': [ {'phone': 'Phone number', 'wa_id': 'WA-ID value', 'type': 'MAIN'}, {'phone': 'Phone number', 'type': 'HOME'}, {'phone': 'Phone number', 'type': 'WORK'} ], } ]

  • to_numberstringObligatorio

    The phone number to send the contacts to, including the country code without the + sign.

  • phone_number_idstringObligatorio

    The phone number ID from which to send the contacts.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send interactive buttonsWHATSAPP_SEND_INTERACTIVE_BUTTONSAcción

Send an interactive button message to a whatsapp number. button messages allow users to quickly respond by tapping up to 3 predefined buttons. perfect for yes/no questions, quick choices, or call-to-action scenarios. note: the message will be delivered to the recipient only if they have texted first.

Parámetros de entrada

  • buttonsobject[]Obligatorio

    List of buttons (maximum 3 buttons).

  • body_textstringObligatorio

    Body text for the button message (up to 1024 characters).

  • to_numberstringObligatorio

    The phone number to send the button message to, including the country code without the + sign.

  • footer_textstring

    Footer text for the button message (up to 60 characters).

  • header_textstring

    Header text for the button message (up to 60 characters).

  • phone_number_idstringObligatorio

    The phone number ID from which to send the button message.

  • reply_to_message_idstring

    The ID of the message to reply to (optional).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send interactive listWHATSAPP_SEND_INTERACTIVE_LISTAcción

Send an interactive list message to a whatsapp number. list messages allow users to select from up to 10 options in a structured format. great for menus, catalogs, or choices. note: the message will be delivered to the recipient only if they have texted first.

Parámetros de entrada

  • sectionsobject[]Obligatorio

    Sections containing list items (maximum 10 sections).

  • body_textstringObligatorio

    Body text for the list message (up to 1024 characters).

  • to_numberstringObligatorio

    The phone number to send the list message to, including the country code without the + sign.

  • button_textstringObligatorio

    Text for the list button (up to 20 characters).

  • footer_textstring

    Footer text for the list message (up to 60 characters).

  • header_textstring

    Header text for the list message (up to 60 characters).

  • phone_number_idstringObligatorio

    The phone number ID from which to send the list message.

  • reply_to_message_idstring

    The ID of the message to reply to (optional).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send locationWHATSAPP_SEND_LOCATIONAcción

Send a location message to a whatsapp number. note: the location will be shared with the recipient only if they have texted first.

Parámetros de entrada

  • namestringObligatorio

    The name associated with the location to be sent.

  • addressstringObligatorio

    The address of the location to be sent.

  • latitudestringObligatorio

    The latitude of the location to be sent.

  • longitudestringObligatorio

    The longitude of the location to be sent.

  • to_numberstringObligatorio

    The phone number to send the location to, including the country code without the + sign.

  • phone_number_idstringObligatorio

    The phone number ID from which to send the location.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send mediaWHATSAPP_SEND_MEDIAAcción

Send a media message to a whatsapp number. note: the media will be delivered to the recipient only if they have texted first.

Parámetros de entrada

  • linkstringObligatorio

    The URL link to the media file to send.

  • captionstring

    The caption to accompany the media, if applicable.

  • to_numberstringObligatorio

    The phone number to send the media to, including the country code without the + sign.

  • media_typestringObligatorioenum

    The type of media to send, such as audio, document, image, sticker, or video.

    audiodocumentimagestickervideo
  • phone_number_idstringObligatorio

    The phone number ID from which to send the media.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send media byWHATSAPP_SEND_MEDIA_BY_IDAcción

Send media using a media id from previously uploaded media. this is more efficient than sending media by url as the media is already on whatsapp servers. use upload media action first to get the media id. note: the media will be delivered to the recipient only if they have texted first.

Parámetros de entrada

  • captionstring

    Caption for the media (not supported for audio and sticker).

  • filenamestring

    Filename for document media.

  • media_idstringObligatorio

    The media ID from uploaded media (use upload_media action to get this ID).

  • to_numberstringObligatorio

    The phone number to send the media to, including the country code without the + sign.

  • media_typestringObligatorioenum

    The type of media to send: audio, document, image, sticker, or video.

    audiodocumentimagestickervideo
  • phone_number_idstringObligatorio

    The phone number ID from which to send the media.

  • reply_to_message_idstring

    The ID of the message to reply to (optional).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send messageWHATSAPP_SEND_MESSAGEAcción

Send a text message to a whatsapp number. note: the message will reflect on the recipient's phone number only if they have texted first.

Parámetros de entrada

  • textstringObligatorio

    The content of the message to be sent.

  • to_numberstringObligatorio

    The phone number to send the message to, including the country code without the + sign.

  • message_idstring

    The ID of the message to be referenced if the message is a reply.

  • preview_urlboolean

    Indicates whether to include a preview of URLs in the message.

  • phone_number_idstringObligatorio

    The phone number ID from which to send the message.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send replyWHATSAPP_SEND_REPLYAcción

Send a reply to a specific message in a whatsapp conversation. this creates a contextual reply that shows which message you're responding to. note: the reply will be delivered to the recipient only if they have texted first.

Parámetros de entrada

  • textstringObligatorio

    The content of the reply message to be sent.

  • to_numberstringObligatorio

    The phone number to send the reply to, including the country code without the + sign.

  • preview_urlboolean

    Indicates whether to include a preview of URLs in the message.

  • phone_number_idstringObligatorio

    The phone number ID from which to send the reply.

  • reply_to_message_idstringObligatorio

    The ID of the message you are replying to.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send template messageWHATSAPP_SEND_TEMPLATE_MESSAGEAcción

Send a template message to a whatsapp number.

Parámetros de entrada

  • to_numberstringObligatorio

    The phone number to send the template message to, including the country code without the + sign.

  • language_codestringenum

    The language code for the template.

    afsqarar_EGar_AEar_LBar_MAar_QAazbe_BYbnbn_IN+99
  • template_namestringObligatorio

    The name of the template to be sent.

  • phone_number_idstringObligatorio

    The phone number ID from which to send the template message.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Upload mediaWHATSAPP_UPLOAD_MEDIAAcción

Upload media files (images, videos, audio, documents, stickers) to whatsapp servers. the uploaded media gets a media id that can be used in send media or other messaging actions. supported formats: - images: jpeg, png (max 5mb) - videos: mp4, 3gpp (max 16mb) - audio: aac, m4a, amr, mp3, ogg (max 16mb) - documents: pdf, doc, docx, ppt, pptx, xls, xlsx (max 100mb) - stickers: webp (max 500kb, 512x512 pixels)

Parámetros de entrada

  • media_typestringObligatorioenum

    Type of media being uploaded: image, video, audio, document, or sticker.

    imagevideoaudiodocumentsticker
  • file_to_uploadobjectObligatorio

    Media file to upload to WhatsApp (max 16MB for most types, 100MB for videos).

  • phone_number_idstringObligatorio

    The phone number ID to upload media for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Triggers (1)

Los triggers son eventos externos que pueden iniciar un flujo en tus agentes (ej: nuevo email, mensaje recibido, registro creado).

Message Status UpdatedWHATSAPP_MESSAGE_STATUS_UPDATED_TRIGGERTrigger

Triggers when a WhatsApp message status changes. IMPORTANT LIMITATION: WhatsApp Cloud API does not provide a native polling endpoint for message status. Status updates are ONLY delivered via webhooks in real-time. This trigger cannot directly poll the WhatsApp API for status updates. This trigger will return empty results as WhatsApp does not support this operation. To track message status updates, you must: 1. Set up a webhook endpoint to receive status notifications from WhatsApp 2. Store the webhook data in your own database 3. Use a different mechanism to query your stored webhook data For more information, see: - https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks

Configuración

  • intervalnumber

    Periodic Interval to Check for Updates & Send a Trigger in Minutes

  • max_resultsinteger

    Maximum number of status updates to retrieve in each poll (1-100).

  • phone_number_idstringObligatorio

    The Meta-assigned numeric ID for the WhatsApp Business phone number to monitor. This is NOT the actual phone number itself - it is a numeric ID (e.g., '712594308615206') assigned by Meta. Obtain it using WHATSAPP_GET_PHONE_NUMBERS action which returns the 'id' field for each phone number.

  • status_filterstring

    Optional: Filter by specific status. Valid values: 'sent', 'delivered', 'read', 'failed'. Leave empty to monitor all status changes.

Payload del evento

  • event_typestring

    Type of event that occurred

  • phone_number_idstringObligatorio

    The phone number ID that sent the message

  • status_updateobjectObligatorio

    The message status update information

Instrucciones

**IMPORTANT: WhatsApp API Limitation** WhatsApp Cloud API does NOT provide an endpoint to poll for message status updates. Status updates are ONLY available via webhooks. **How Message Status Updates Work in WhatsApp:** 1. When you send a message, WhatsApp returns a message ID 2. As the message progresses through statuses (sent → delivered → read), WhatsApp sends status updates to your configured webhook endpoint 3. Statuses include: 'sent', 'delivered', 'read', 'failed' 4. There is NO API endpoint to retrieve these status updates via polling **To Track Message Status:** - Set up a webhook endpoint in your WhatsApp Business Account settings - Configure the webhook to receive "messages" events - Store incoming webhook data in your own database - Use your database to track message status changes **This Trigger:** This trigger documents the expected structure for message status updates but will return empty results since WhatsApp does not support polling for this data. **Alternative Solutions:** - Use WhatsApp's webhook system with your own storage layer - Implement a webhook receiver that stores status updates - Query your storage layer instead of the WhatsApp API For webhook documentation, visit: https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components