Skip to content
Registry

whatsapp

v0.2.0

Native whatsmeow sessions and official Meta Cloud API messaging in one Go worker; no Node or browser runtime.

license: Apache-2.0cloud-apigogroupsmessagingnativewhatsapp

Install

bash
iii trigger compose::add worker=whatsapp

Run in your project with the iii engine running. Exact versions are immutable and digest-pinned.

Functions239

whatsapp::calls::reject

Function
Request
  • call_creatorstringrequired
  • call_idstringrequired
  • peerstringrequired
  • session_idstringrequired
Response
  • requestedbooleanrequired

    The signaling stanza was sent; no remote acknowledgement is provided.

whatsapp::chats::archive

Function
Request
  • chat_idstringrequired
  • message_rangeany of
    any of (2)
    Variant 1
    • last_message_timestamp_msinteger· int64required
    • last_system_message_timestamp_msinteger· int64
    • messagesobject[]
      Show 2 nested
      • keyobjectrequired

        Keeps an original sender's namespace, including LID, for message operations.

        Show 4 nested
        • chat_idstringrequired
        • from_mebooleanrequired
        • message_idstringrequired
        • participant_idstring
      • timestamp_msinteger· int64required
    Variant 2
    valuenull
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::chats::clear

Function
Request
  • chat_idstringrequired
  • delete_mediabooleanrequired
  • delete_starredbooleanrequired
  • message_rangeany of
    any of (2)
    Variant 1
    • last_message_timestamp_msinteger· int64required
    • last_system_message_timestamp_msinteger· int64
    • messagesobject[]
      Show 2 nested
      • keyobjectrequired

        Keeps an original sender's namespace, including LID, for message operations.

        Show 4 nested
        • chat_idstringrequired
        • from_mebooleanrequired
        • message_idstringrequired
        • participant_idstring
      • timestamp_msinteger· int64required
    Variant 2
    valuenull
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::chats::delete

Function
Request
  • chat_idstringrequired
  • delete_mediabooleanrequired
  • message_rangeany of
    any of (2)
    Variant 1
    • last_message_timestamp_msinteger· int64required
    • last_system_message_timestamp_msinteger· int64
    • messagesobject[]
      Show 2 nested
      • keyobjectrequired

        Keeps an original sender's namespace, including LID, for message operations.

        Show 4 nested
        • chat_idstringrequired
        • from_mebooleanrequired
        • message_idstringrequired
        • participant_idstring
      • timestamp_msinteger· int64required
    Variant 2
    valuenull
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::chats::list

Function
Request
  • cursorstring
  • limitinteger· uintmin 0
  • querystring
  • session_idstringrequired
Response
  • chatsobject[]required
    • chat_idstringrequired
    • is_groupbooleanrequired
    • last_messageany of
      any of (2)
      Variant 1
      • chat_idstringrequired
      • from_mebooleanrequired
      • kindstringrequired
      • message_idstringrequired
      • sender_idstringrequired
      • sender_namestring
      • sourcestringrequired
      • statusstring
      • textstringrequired
      • timestamp_msinteger· int64required
      Variant 2
      valuenull
    • message_countinteger· uintrequiredmin 0
    • titlestringrequired
  • coverageobjectrequired
    • capture_started_at_msinteger· int64required
    • last_history_sync_at_msinteger· int64
    • last_history_sync_progressinteger· uint32min 0
    • message_limitinteger· uintrequiredmin 0
    • retention_truncatedbooleanrequired
  • next_cursorstring

whatsapp::chats::lock

Function
Request
  • chat_idstringrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::chats::mark_read

Function
Request
  • chat_idstringrequired
  • message_rangeany of
    any of (2)
    Variant 1
    • last_message_timestamp_msinteger· int64required
    • last_system_message_timestamp_msinteger· int64
    • messagesobject[]
      Show 2 nested
      • keyobjectrequired

        Keeps an original sender's namespace, including LID, for message operations.

        Show 4 nested
        • chat_idstringrequired
        • from_mebooleanrequired
        • message_idstringrequired
        • participant_idstring
      • timestamp_msinteger· int64required
    Variant 2
    valuenull
  • readbooleanrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::chats::mute

Function
Request
  • chat_idstringrequired
  • session_idstringrequired
  • until_timestamp_msinteger· int64
Response
  • appliedbooleanrequired

whatsapp::chats::pin

Function
Request
  • chat_idstringrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::chats::presence

Function
Request
  • presencestringrequiredenum available, unavailable
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::chats::state

Function
Request
  • chat_idstringrequired
  • session_idstringrequired
  • statestringrequiredenum composing, recording, paused
Response
  • appliedbooleanrequired

whatsapp::chats::subscribe_presence

Function
Request
  • chat_idstringrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::chats::unarchive

Function
Request
  • chat_idstringrequired
  • message_rangeany of
    any of (2)
    Variant 1
    • last_message_timestamp_msinteger· int64required
    • last_system_message_timestamp_msinteger· int64
    • messagesobject[]
      Show 2 nested
      • keyobjectrequired

        Keeps an original sender's namespace, including LID, for message operations.

        Show 4 nested
        • chat_idstringrequired
        • from_mebooleanrequired
        • message_idstringrequired
        • participant_idstring
      • timestamp_msinteger· int64required
    Variant 2
    valuenull
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::chats::unlock

Function
Request
  • chat_idstringrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::chats::unmute

Function
Request
  • chat_idstringrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::chats::unpin

Function
Request
  • chat_idstringrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::cloud::analytics::get

Function
Request
  • endintegerrequired1…253402300799
  • fieldstringrequiredenum analytics, conversation_analytics, pricing_analytics, template_analytics, template_group_analytics, call_analytics, …
  • granularitystringrequiredenum HALF_HOUR, DAY, MONTH, DAILY, MONTHLY
  • group_idsstring[]1…128 chars · /^[A-Za-z0-9_-]+$/ · 1…1 items
  • metric_typesstring[]1…40 chars · 1…10 items
  • startintegerrequired1…253402300799
  • template_group_idsstring[]1…128 chars · /^[0-9]+$/ · 1…10 items
  • template_idsstring[]1…128 chars · /^[0-9]+$/ · 1…10 items
Response
  • dataany ofrequired
    any of (6)
    Variant 1
    valuenull
    Variant 2
    valueboolean
    Variant 3
    valuenumber
    Variant 4
    valuestring0…131072 chars
    Variant 5
    itemsunknown[]
    Variant 6
    Empty object
  • fieldstringrequired1…64 chars

whatsapp::cloud::blocking::block

Function
Request
  • usersstring[]required6…16 chars · /^\+?[1-9][0-9]{5,14}$/ · 1…1000 items
Response
  • block_usersobjectrequired

whatsapp::cloud::blocking::list

Function
Request
  • afterstring0…2048 chars
  • limitinteger1…100
Response
  • itemsobject[]requiredmax 1000 items
    • inputstringmax 8192 chars
    • user_idstringmax 8192 chars
    • wa_idstringmax 8192 chars
  • next_cursorstringrequiredmax 2048 chars

whatsapp::cloud::blocking::unblock

Function
Request
  • usersstring[]required6…16 chars · /^\+?[1-9][0-9]{5,14}$/ · 1…1000 items
Response
  • block_usersobjectrequired

whatsapp::cloud::calls::accept

Function
Request
  • biz_opaque_callback_datastringmax 512 chars
  • call_idstringrequiredmax 1024 chars · /^wacid\.[A-Za-z0-9_+/=-]+$/
  • sessionobject
    • sdpstringrequired5…65536 chars
    • sdp_typestringrequiredenum answer
Response
  • actionstringrequired
  • call_idstringrequiredmax 1024 chars · /^wacid\.[A-Za-z0-9_+/=-]+$/
  • statusstringrequiredenum accepted

whatsapp::cloud::calls::connect

Function
Request
  • biz_opaque_callback_datastringmax 512 chars
  • chat_idstringrequired
  • sessionobjectrequired
    • sdpstringrequired5…65536 chars
    • sdp_typestringrequiredenum offer
Response
  • actionstringrequired
  • call_idstringrequiredmax 1024 chars · /^wacid\.[A-Za-z0-9_+/=-]+$/
  • statusstringrequiredenum accepted

whatsapp::cloud::calls::permissions::get

Function
Request
  • chat_idstringrequired
Response
Empty object

whatsapp::cloud::calls::permissions::request

Function
Request
  • chat_idstringrequired
  • recipient_identity_key_hashstringmax 512 chars
  • reply_to_message_idstringmax 512 chars
  • textstringmax 1024 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::calls::pre_accept

Function
Request
  • biz_opaque_callback_datastringmax 512 chars
  • call_idstringrequiredmax 1024 chars · /^wacid\.[A-Za-z0-9_+/=-]+$/
  • sessionobjectrequired
    • sdpstringrequired5…65536 chars
    • sdp_typestringrequiredenum answer
Response
  • actionstringrequired
  • call_idstringrequiredmax 1024 chars · /^wacid\.[A-Za-z0-9_+/=-]+$/
  • statusstringrequiredenum accepted

whatsapp::cloud::calls::reject

Function
Request
  • call_idstringrequiredmax 1024 chars · /^wacid\.[A-Za-z0-9_+/=-]+$/
Response
  • actionstringrequired
  • call_idstringrequiredmax 1024 chars · /^wacid\.[A-Za-z0-9_+/=-]+$/
  • statusstringrequiredenum accepted

whatsapp::cloud::calls::settings::get

Function
Request
Empty object
Response
Empty object

whatsapp::cloud::calls::settings::update

Function
Request
  • callingobjectrequired
    • audioobject
      • additional_codecsstring[]requiredenum PCMA, PCMUmax 2 items
    • call_hoursobject
      • holiday_scheduleobject[]max 20 items
        Show 3 nested
        • datestringrequired/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/
        • end_timestringrequired/^(?:[01][0-9]|2[0-3])[0-5][0-9]$/
        • start_timestringrequired/^(?:[01][0-9]|2[0-3])[0-5][0-9]$/
      • statusstringrequiredenum ENABLED, DISABLED
      • timezone_idstring
      • weekly_operating_hoursobject[]max 14 items
        Show 3 nested
        • close_timestringrequired/^(?:[01][0-9]|2[0-3])[0-5][0-9]$/
        • day_of_weekstringrequiredenum MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, …
        • open_timestringrequired/^(?:[01][0-9]|2[0-3])[0-5][0-9]$/
    • call_icon_visibilitystringenum DEFAULT, DISABLE_ALL
    • call_iconsobject
      • restrict_to_user_countriesstring[]required/^[A-Z]{2}$/ · max 250 items
    • callback_permission_statusstringenum ENABLED, DISABLED
    • sipobject
      • serversobject[]max 1 items
        Show 3 nested
        • hostnamestringrequiredmax 253 chars
        • portinteger1…65535
        • request_uri_user_paramsobject
      • statusstringenum ENABLED, DISABLED
    • statusstringenum ENABLED, DISABLED
    • voicemailobject
      • audioobject
        Show 1 nested
        • defaultobjectrequired
          Show 2 nested
          • announcement_media_idstringrequired/^[0-9]{1,128}$/

            Numeric Meta media ID as a string to preserve precision; encoded as an integer in the Meta request.

          • timeout_secondsinteger0…30
      • statusstringrequiredenum ENABLED, DISABLED
      • triggersstring[]enum REJECT, TIMEOUTmax 2 items
Response
Empty object

whatsapp::cloud::calls::terminate

Function
Request
  • call_idstringrequiredmax 1024 chars · /^wacid\.[A-Za-z0-9_+/=-]+$/
Response
  • actionstringrequired
  • call_idstringrequiredmax 1024 chars · /^wacid\.[A-Za-z0-9_+/=-]+$/
  • statusstringrequiredenum accepted

whatsapp::cloud::chats::list

Function
Request
  • cursorstring
  • limitinteger· uint1…200
  • querystring
Response
  • chatsobject[]required
    • chat_idstringrequired
    • is_groupbooleanrequired
    • last_messageany of
      any of (2)
      Variant 1
      • chat_idstringrequired
      • from_mebooleanrequired
      • kindstringrequired
      • message_idstringrequired
      • sender_idstringrequired
      • sender_namestring
      • sourcestringrequired
      • statusstring
      • textstringrequired
      • timestamp_msinteger· int64required
      Variant 2
      valuenull
    • message_countinteger· uintrequiredmin 0
    • titlestringrequired
  • coverageobjectrequired
    • capture_started_at_msinteger· int64required
    • last_history_sync_at_msinteger· int64
    • last_history_sync_progressinteger· uint32min 0
    • message_limitinteger· uintrequiredmin 0
    • retention_truncatedbooleanrequired
  • next_cursorstring

whatsapp::cloud::check_connection

Function
Request
Empty object
Response
  • phoneobjectrequired
    • code_verification_statusstring
    • display_phone_numberstringrequired
    • idstringrequired
    • quality_ratingstring
    • verified_namestringrequired
  • phone_in_business_accountbooleanrequired
  • subscribed_appsobject[]required
    • idstringrequired
    • namestringrequired

whatsapp::cloud::commerce::get

Function
Request
Empty object
Response
  • settingsobjectrequired
    • idstring1…128 chars · /^[0-9]+$/
    • is_cart_enabledboolean
    • is_catalog_visibleboolean

whatsapp::cloud::commerce::update

Function
Request
  • is_cart_enabledboolean
  • is_catalog_visibleboolean
Response
  • successbooleanrequired

whatsapp::cloud::conversational_components::get

Function
Request
Empty object
Response
  • settingsany ofrequired
    any of (2)
    Variant 1
    • commandsobject[]max 1000 items
      Show 2 nested
      • command_descriptionstringmax 8192 chars
      • command_namestringmax 8192 chars
    • promptsstring[]max 8192 chars · max 1000 items
    Variant 2
    valuenull

whatsapp::cloud::conversational_components::update

Function
Request
  • commandsobject[]0…30 items
    • command_descriptionstringrequired1…256 chars
    • command_namestringrequired1…32 chars · /^[A-Za-z0-9_]+$/
  • promptsstring[]1…80 chars · 0…4 items
Response
  • successbooleanrequired

whatsapp::cloud::flows::assets::download

Function
Request
  • flow_idstringrequired/^[0-9]{1,128}$/
Response
  • asset_typeunknownrequired
  • data_base64stringrequired
  • file_lengthintegerrequired1…10000000
  • mimetypeunknownrequired
  • nameunknownrequired

whatsapp::cloud::flows::assets::list

Function
Request
  • flow_idstringrequired/^[0-9]{1,128}$/
Response
  • dataobject[]required
    Empty object
  • next_cursorstringrequiredmax 2048 chars

whatsapp::cloud::flows::assets::upload

Function
Request
  • data_base64stringrequired1…13333336 chars
  • flow_idstringrequired/^[0-9]{1,128}$/
Response
  • successbooleanrequired

    Meta operation result. False with validation_errors requires correcting the Flow JSON before publishing.

  • validation_errorsobject[]
    Empty object

whatsapp::cloud::flows::create

Function
Request
  • categoriesstring[]requiredenum SIGN_UP, SIGN_IN, APPOINTMENT_BOOKING, LEAD_GENERATION, CONTACT_US, CUSTOMER_SUPPORT, …1…8 items
  • clone_flow_idstring/^[0-9]{1,128}$/
  • endpoint_uristringmax 2048 chars
  • flow_jsonobject
  • namestringrequired1…256 chars
  • publishboolean
Response
  • categoriesstring[]max 128 chars
  • data_api_versionstringmax 128 chars

    Flow data API version

  • endpoint_uristringmax 2048 chars

    Data exchange endpoint URL

  • idstring/^[0-9]{1,128}$/
  • json_versionstringmax 128 chars

    Flow JSON version

  • namestringmax 256 chars

    Flow name

  • previewobject
  • statusstringmax 128 chars

    Meta Flow lifecycle status

  • successboolean

    Meta operation result. False with validation_errors requires correcting the Flow JSON before publishing.

  • validation_errorsobject[]
    Empty object
  • whatsapp_business_accountobject

whatsapp::cloud::flows::delete

Function
Request
  • flow_idstringrequired/^[0-9]{1,128}$/
Response
  • successbooleanrequired

    Meta operation result. False with validation_errors requires correcting the Flow JSON before publishing.

  • validation_errorsobject[]
    Empty object

whatsapp::cloud::flows::deprecate

Function
Request
  • flow_idstringrequired/^[0-9]{1,128}$/
Response
  • successbooleanrequired

    Meta operation result. False with validation_errors requires correcting the Flow JSON before publishing.

  • validation_errorsobject[]
    Empty object

whatsapp::cloud::flows::encryption::get

Function
Request
Empty object
Response
  • business_public_keystring
  • business_public_key_signature_statusstring

whatsapp::cloud::flows::encryption::set

Function
Request
  • public_keystringmax 16384 chars
Response
  • successbooleanrequired

    Meta operation result. False with validation_errors requires correcting the Flow JSON before publishing.

  • validation_errorsobject[]
    Empty object

whatsapp::cloud::flows::endpoint

Function
Request
any of (2)
Variant 1
  • headersany of
    any of (2)
    Variant 1
    Empty object
    Variant 2
    valuenull
  • request_bodyany of
    any of (2)
    Variant 1
    • access_keystring
    • channel_idstring
    • directionstring
    Variant 2
    valuenull
Variant 2
valuenull
Response
  • bodystringrequired
  • headersobjectrequired
  • status_codeintegerrequired

whatsapp::cloud::flows::endpoint::status

Function
Request
Empty object
Response
  • configuredbooleanrequired
  • handler_functionstringrequired
  • handler_namespacestringrequired
  • pathstringrequired
  • private_key_setbooleanrequired

whatsapp::cloud::flows::get

Function
Request
  • flow_idstringrequired/^[0-9]{1,128}$/
Response
  • categoriesstring[]max 128 chars
  • data_api_versionstringmax 128 chars

    Flow data API version

  • endpoint_uristringmax 2048 chars

    Data exchange endpoint URL

  • idstring/^[0-9]{1,128}$/
  • json_versionstringmax 128 chars

    Flow JSON version

  • namestringmax 256 chars

    Flow name

  • previewobject
  • statusstringmax 128 chars

    Meta Flow lifecycle status

  • successboolean

    Meta operation result. False with validation_errors requires correcting the Flow JSON before publishing.

  • validation_errorsobject[]
    Empty object
  • whatsapp_business_accountobject

whatsapp::cloud::flows::list

Function
Request
  • afterstringmax 2048 chars
  • limitinteger1…100
Response
  • dataobject[]required
    Empty object
  • next_cursorstringrequiredmax 2048 chars

whatsapp::cloud::flows::preview

Function
Request
  • flow_idstringrequired/^[0-9]{1,128}$/
Response
  • previewobjectrequired

whatsapp::cloud::flows::publish

Function
Request
  • flow_idstringrequired/^[0-9]{1,128}$/
Response
  • successbooleanrequired

    Meta operation result. False with validation_errors requires correcting the Flow JSON before publishing.

  • validation_errorsobject[]
    Empty object

whatsapp::cloud::flows::update

Function
Request
  • categoriesstring[]enum SIGN_UP, SIGN_IN, APPOINTMENT_BOOKING, LEAD_GENERATION, CONTACT_US, CUSTOMER_SUPPORT, …1…8 items
  • endpoint_uristringmax 2048 chars
  • flow_idstringrequired/^[0-9]{1,128}$/
  • namestringrequired1…256 chars
Response
  • successbooleanrequired

    Meta operation result. False with validation_errors requires correcting the Flow JSON before publishing.

  • validation_errorsobject[]
    Empty object

whatsapp::cloud::groups::create

Function
Request
  • descriptionstringmax 2048 chars
  • join_approval_modestringenum auto_approve, approval_required
  • subjectstringrequired1…128 chars
Response
Empty object

whatsapp::cloud::groups::delete

Function
Request
  • group_idstringrequired/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/

    Opaque official Cloud group ID, without group: prefix or native JID.

Response
Empty object

whatsapp::cloud::groups::get

Function
Request
  • fieldsstring[]enum join_approval_mode, subject, description, suspended, creation_timestamp, participants, …max 7 items
  • group_idstringrequired/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/

    Opaque official Cloud group ID, without group: prefix or native JID.

Response
Empty object

whatsapp::cloud::groups::invite_link::get

Function
Request
  • group_idstringrequired/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/

    Opaque official Cloud group ID, without group: prefix or native JID.

Response
Empty object

whatsapp::cloud::groups::invite_link::reset

Function
Request
  • group_idstringrequired/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/

    Opaque official Cloud group ID, without group: prefix or native JID.

Response
Empty object

whatsapp::cloud::groups::join_requests::approve

Function
Request
  • group_idstringrequired/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/

    Opaque official Cloud group ID, without group: prefix or native JID.

  • join_request_idsstring[]required/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/ · 1…100 items
Response
Empty object

whatsapp::cloud::groups::join_requests::list

Function
Request
  • afterstring
  • group_idstringrequired/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/

    Opaque official Cloud group ID, without group: prefix or native JID.

  • limitinteger1…100
Response
Empty object

whatsapp::cloud::groups::join_requests::reject

Function
Request
  • group_idstringrequired/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/

    Opaque official Cloud group ID, without group: prefix or native JID.

  • join_request_idsstring[]required/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/ · 1…100 items
Response
Empty object

whatsapp::cloud::groups::list

Function
Request
  • afterstring
  • limitinteger1…1024
Response
Empty object

whatsapp::cloud::groups::messages::pin

Function
Request
  • expiration_daysintegerrequired1…30
  • group_idstringrequired/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/

    Opaque official Cloud group ID, without group: prefix or native JID.

  • message_idstringrequired1…512 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::groups::messages::send_media

Function
Request
  • captionstringmax 1024 chars
  • file_namestringmax 255 chars
  • group_idstringrequired/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/

    Opaque official Cloud group ID, without group: prefix or native JID.

  • media_idstringrequired/^[0-9]{1,128}$/
  • media_typestringrequiredenum image, audio, video, sticker, document
  • reply_to_message_idstringmax 512 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::groups::messages::send_template

Function
Request
  • componentsobject[]
    Empty object
  • group_idstringrequired/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/

    Opaque official Cloud group ID, without group: prefix or native JID.

  • languagestringrequired/^[A-Za-z0-9_]{1,32}$/
  • namestringrequired/^[a-z0-9_]{1,512}$/
  • reply_to_message_idstringmax 512 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::groups::messages::send_text

Function
Request
  • group_idstringrequired/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/

    Opaque official Cloud group ID, without group: prefix or native JID.

  • preview_urlboolean
  • reply_to_message_idstringmax 512 chars
  • textstringrequired1…4096 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::groups::messages::unpin

Function
Request
  • group_idstringrequired/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/

    Opaque official Cloud group ID, without group: prefix or native JID.

  • message_idstringrequired1…512 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::groups::participants::remove

Function
Request
  • group_idstringrequired/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/

    Opaque official Cloud group ID, without group: prefix or native JID.

  • participant_idsstring[]required1…8 items
Response
Empty object

whatsapp::cloud::groups::photo::set

Function
Request
  • data_base64stringrequiredmin 1 chars
  • file_namestringrequired1…255 chars
  • group_idstringrequired/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/

    Opaque official Cloud group ID, without group: prefix or native JID.

  • mimetypestringrequiredenum image/jpeg
Response
Empty object

whatsapp::cloud::groups::update

Function
Request
  • descriptionstringmax 2048 chars
  • group_idstringrequired/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/

    Opaque official Cloud group ID, without group: prefix or native JID.

  • subjectstring1…128 chars
Response
Empty object

whatsapp::cloud::identity::get

Function
Request
Empty object
Response
  • settingsany ofrequired
    any of (2)
    Variant 1
    • enable_identity_key_checkboolean
    • enabledboolean
    Variant 2
    valuenull

whatsapp::cloud::identity::update

Function
Request
  • enable_identity_key_checkbooleanrequired
Response
  • successbooleanrequired

whatsapp::cloud::media::delete

Function
Request
  • media_idstringrequired/^[0-9]{1,128}$/

    Meta media ID. Never a URL, native media key or host file path.

Response
  • deletedbooleanrequired
  • media_idstringrequired/^[0-9]{1,128}$/

    Meta media ID. Never a URL, native media key or host file path.

whatsapp::cloud::media::download

Function
Request
  • media_idstringrequired/^[0-9]{1,128}$/

    Meta media ID. Never a URL, native media key or host file path.

Response
  • data_base64stringrequired
  • file_lengthintegerrequiredmin 1
  • media_idstringrequired/^[0-9]{1,128}$/

    Meta media ID. Never a URL, native media key or host file path.

  • mimetypestringrequired
  • sha256stringrequired/^[0-9a-f]{64}$/

    SHA-256 digest as lowercase hexadecimal.

whatsapp::cloud::media::get

Function
Request
  • media_idstringrequired/^[0-9]{1,128}$/

    Meta media ID. Never a URL, native media key or host file path.

Response
  • file_lengthintegerrequiredmin 1
  • media_idstringrequired/^[0-9]{1,128}$/

    Meta media ID. Never a URL, native media key or host file path.

  • mimetypestringrequired
  • sha256stringrequired/^[0-9a-f]{64}$/

    SHA-256 digest as lowercase hexadecimal.

whatsapp::cloud::media::upload

Function
Request
  • data_base64stringrequiredmin 1 chars
  • file_namestringrequired1…255 chars

    A matching file extension, without paths or controls. Markdown is not supported.

  • media_typestringrequiredenum image, audio, video, sticker, document
  • mimetypestringrequired

    Exact supported MIME; audio/ogg or audio/ogg; codecs=opus requires mono Opus.

Response
  • file_lengthintegerrequiredmin 1
  • file_namestringrequired
  • media_idstringrequired/^[0-9]{1,128}$/

    Meta media ID. Never a URL, native media key or host file path.

  • media_typestringrequired
  • mimetypestringrequired

whatsapp::cloud::media::upload_document

Function
Request
  • data_base64stringrequired4…89478488 chars

    Standard padded base64, no data URL. Decoded bytes must fit max_media_bytes (default 16 MiB; configurable to 64 MiB) and the conservative 100,000,000-byte Cloud ceiling. No automatic conversion.

  • file_namestringrequired1…255 chars

    Display filename with supported extension; maximum 255 UTF-8 bytes (worker policy), without paths or control characters. Markdown is not supported; choose TXT or PDF explicitly.

  • mimetypestringrequired1…200 chars

    Official document MIME type: text/plain, application/pdf, application/msword, application/vnd.ms-excel, application/vnd.ms-powerpoint, or the corresponding Office Open XML MIME. Must match filename extension and content. text/markdown is rejected with an explicit alternative.

Response
  • file_lengthintegerrequired1…100000000

    Number of decoded file bytes uploaded.

  • file_namestringrequired1…255 chars

    Display filename with supported extension; maximum 255 UTF-8 bytes (worker policy), without paths or control characters. Markdown is not supported; choose TXT or PDF explicitly.

  • media_idstringrequired1…128 chars · /^[0-9]+$/

    Meta media ID from upload_document, valid for 30 days unless deleted. Reuse without uploading bytes again. Numeric IDs are strings; 128-character bound is worker policy.

  • mimetypestringrequired

whatsapp::cloud::media::upload_voicemail_announcement

Function
Request
  • data_base64stringrequiredmin 1 chars
  • descriptionstringmax 1024 chars
  • file_namestringrequired1…255 chars

    A matching file extension, without paths or controls. Markdown is not supported.

  • mimetypestringrequiredenum audio/ogg, audio/ogg; codecs=opus
Response
  • file_lengthintegerrequiredmin 1
  • file_namestringrequired
  • media_idstringrequired/^[0-9]{1,128}$/

    Meta media ID. Never a URL, native media key or host file path.

  • media_typestringrequired
  • mimetypestringrequired
  • use_casestringrequiredenum call_voicemail_announcement

whatsapp::cloud::messages::list

Function
Request
  • chat_idstringrequired
  • cursorstring
  • limitinteger· uint1…200
Response
  • coverageobjectrequired
    • capture_started_at_msinteger· int64required
    • last_history_sync_at_msinteger· int64
    • last_history_sync_progressinteger· uint32min 0
    • message_limitinteger· uintrequiredmin 0
    • retention_truncatedbooleanrequired
  • messagesobject[]required

    Newest first. A cursor loads older locally retained messages.

    • chat_idstringrequired
    • from_mebooleanrequired
    • kindstringrequired
    • message_idstringrequired
    • sender_idstringrequired
    • sender_namestring
    • sourcestringrequired
    • statusstring
    • textstringrequired
    • timestamp_msinteger· int64required
  • next_cursorstring

whatsapp::cloud::messages::mark_read

Function
Request
  • message_idstringrequired1…512 chars

    Original incoming Meta message ID, without whitespace or control characters.

Response
  • successbooleanrequired

whatsapp::cloud::messages::request_address

Function
Request
  • chat_idstringrequired1…136 chars
  • countrystringrequiredenum IN
  • footerstringmax 60 chars
  • recipient_identity_key_hashstring1…512 chars
  • reply_to_message_idstring1…512 chars
  • saved_addressesobject[]0…10 items
    • idstringrequired1…256 chars
    • valueobjectrequired
      • addressstring
      • building_namestring
      • citystring
      • floor_numberstring
      • house_numberstring
      • in_pin_codestring
      • landmark_areastring
      • namestring
      • phone_numberstring
      • statestring
      • tower_numberstring
  • textstringrequiredmax 1024 chars
  • validation_errorsobject
    • addressstring
    • building_namestring
    • citystring
    • floor_numberstring
    • house_numberstring
    • in_pin_codestring
    • landmark_areastring
    • namestring
    • phone_numberstring
    • statestring
    • tower_numberstring
  • valuesobject
    • addressstring
    • building_namestring
    • citystring
    • floor_numberstring
    • house_numberstring
    • in_pin_codestring
    • landmark_areastring
    • namestring
    • phone_numberstring
    • statestring
    • tower_numberstring
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::request_location

Function
Request
  • chat_idstringrequired1…136 chars

    International phone number or supported business-scoped user ID; native JIDs are not accepted.

  • recipient_identity_key_hashstring1…512 chars

    Optional recipient identity key hash for identity-change protection.

  • reply_to_message_idstring1…512 chars

    Optional original Meta message ID to quote; no automatic retries.

  • textstringrequired1…1024 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_audio

Function
Request
  • chat_idstringrequired

    International phone number or business-scoped user ID; native JIDs are rejected.

  • media_idstringrequired/^[0-9]{1,128}$/

    Meta media ID. Never a URL, native media key or host file path.

  • recipient_identity_key_hashstringmax 512 chars

    Optional expected recipient identity key hash.

  • reply_to_message_idstringmax 512 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_buttons

Function
Request
  • buttonsobject[]required1…3 items
    • idstringrequired1…256 chars
    • titlestringrequired1…20 chars
  • chat_idstringrequired1…136 chars

    International phone number or supported business-scoped user ID; native JIDs are not accepted.

  • footerstringmax 60 chars
  • headerobject
    • media_idstring1…128 chars · /^[0-9]+$/
    • textstring1…60 chars
    • typestringrequiredenum text, image, video, document
  • recipient_identity_key_hashstring1…512 chars

    Optional recipient identity key hash for identity-change protection.

  • reply_to_message_idstring1…512 chars

    Optional original Meta message ID to quote; no automatic retries.

  • textstringrequired1…1024 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_catalog

Function
Request
  • chat_idstringrequired1…136 chars
  • footerstringmax 60 chars
  • recipient_identity_key_hashstring1…512 chars
  • reply_to_message_idstring1…512 chars
  • textstringrequiredmax 1024 chars
  • thumbnail_product_retailer_idstring1…256 chars

    Catalog SKU/content ID; 256-character worker limit.

Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_contacts

Function
Request
  • chat_idstringrequired1…136 chars

    International phone number or supported business-scoped user ID; native JIDs are not accepted.

  • contactsobject[]required1…257 items
    • addressesobject[]
      • citystring
      • countrystring
      • country_codestring2…2 chars · /^[A-Z]{2}$/
      • statestring
      • streetstring
      • typestring
      • zipstring
    • birthdaystring/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/
    • emailsobject[]
      • emailstring· emailrequired
      • typestring
    • nameobjectrequired
      • first_namestringmax 1024 chars
      • formatted_namestringrequired1…1024 chars
      • last_namestringmax 1024 chars
      • middle_namestringmax 1024 chars
      • prefixstringmax 1024 chars
      • suffixstringmax 1024 chars
    • orgobject
      • companystring
      • departmentstring
      • titlestring
    • phonesobject[]
      • phonestring
      • typestring
      • wa_idstring
    • urlsobject[]
      • typestring
      • urlstringrequired1…2048 chars

        HTTP(S) display URL; never fetched by the worker.

  • recipient_identity_key_hashstring1…512 chars

    Optional recipient identity key hash for identity-change protection.

  • reply_to_message_idstring1…512 chars

    Optional original Meta message ID to quote; no automatic retries.

Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_cta_url

Function
Request
  • chat_idstringrequired1…136 chars

    International phone number or supported business-scoped user ID; native JIDs are not accepted.

  • display_textstringrequired1…20 chars
  • footerstringmax 60 chars
  • headerobject
    • media_idstring1…128 chars · /^[0-9]+$/
    • textstring1…60 chars
    • typestringrequiredenum text, image, video, document
  • recipient_identity_key_hashstring1…512 chars

    Optional recipient identity key hash for identity-change protection.

  • reply_to_message_idstring1…512 chars

    Optional original Meta message ID to quote; no automatic retries.

  • textstringrequired1…1024 chars
  • urlstringrequired1…2048 chars

    HTTP(S) destination opened by the recipient; never fetched by the worker.

Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_direct

Function
Request
  • buttonsobject[]1…3 items
    • idstringrequired1…256 chars
    • titlestringrequired1…20 chars
  • categorystringrequiredenum utility, authentication, service
  • chat_idstringrequired1…136 chars

    International phone number or supported business-scoped user ID; native JIDs are not accepted.

  • display_textstring1…20 chars
  • footerstringmax 60 chars
  • headerobject
    • media_idstring1…128 chars · /^[0-9]+$/
    • textstring1…60 chars
    • typestringrequiredenum text, image, video, document
  • recipient_identity_key_hashstring1…512 chars

    Optional recipient identity key hash for identity-change protection.

  • reply_to_message_idstring1…512 chars

    Optional original Meta message ID to quote; no automatic retries.

  • template_namestring1…512 chars · /^[a-z0-9_]+$/

    Restricted utility-only business-named template feature.

  • textstringrequired1…4096 chars

    Text body limit 4096; interactive body limit 1024.

  • ttl_secondsinteger30…43200

    Utility30..43200; authentication30..900; forbidden for service.

  • typestringrequiredenum text, buttons, cta_url
  • urlstring1…2048 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_document

Function
Request
  • captionstringmax 1024 chars

    Optional caption of at most 1024 Unicode characters.

  • chat_idstringrequired1…136 chars

    International phone number or supported business-scoped user ID; native/group JIDs are not accepted.

  • file_namestringrequired1…255 chars

    Display filename with supported extension; maximum 255 UTF-8 bytes (worker policy), without paths or control characters. Markdown is not supported; choose TXT or PDF explicitly.

  • media_idstringrequired1…128 chars · /^[0-9]+$/

    Meta media ID from upload_document, valid for 30 days unless deleted. Reuse without uploading bytes again. Numeric IDs are strings; 128-character bound is worker policy.

  • recipient_identity_key_hashstringmax 512 chars

    Optional expected recipient identity hash for Meta identity-change checks.

  • reply_to_message_idstringmax 512 chars

    Optional Meta message ID to quote as a contextual reply.

Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_flow

Function
Request
  • chat_idstringrequired1…136 chars

    International phone number or supported business-scoped user ID; native JIDs are not accepted.

  • dataobject

    Optional non-empty input data for the first navigate screen, at most 16384 JSON bytes. Not accepted with data_exchange.

  • flow_actionstringenum navigate, data_exchange
  • flow_ctastringrequired1…30 chars

    CTA label; worker follows Meta recommendation of at most 30 characters.

  • flow_idstring1…32 chars · /^[0-9]+$/
  • flow_namestring1…255 chars
  • flow_tokenstringmax 4096 chars

    Optional business correlation token; 4096-character worker limit.

  • footerstringmax 60 chars
  • headerobject
    • media_idstring1…128 chars · /^[0-9]+$/
    • textstring1…60 chars
    • typestringrequiredenum text
  • modestringenum published, draft
  • recipient_identity_key_hashstring1…512 chars

    Optional recipient identity key hash for identity-change protection.

  • reply_to_message_idstring1…512 chars

    Optional original Meta message ID to quote; no automatic retries.

  • screenstring1…256 chars

    Required for navigate; forbidden for data_exchange. Worker limit 256 characters.

  • textstringrequired1…1024 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_image

Function
Request
  • captionstringmax 1024 chars
  • chat_idstringrequired

    International phone number or business-scoped user ID; native JIDs are rejected.

  • media_idstringrequired/^[0-9]{1,128}$/

    Meta media ID. Never a URL, native media key or host file path.

  • recipient_identity_key_hashstringmax 512 chars

    Optional expected recipient identity key hash.

  • reply_to_message_idstringmax 512 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_list

Function
Request
  • buttonstringrequired1…20 chars
  • chat_idstringrequired1…136 chars

    International phone number or supported business-scoped user ID; native JIDs are not accepted.

  • footerstringmax 60 chars
  • headerobject
    • media_idstring1…128 chars · /^[0-9]+$/
    • textstring1…60 chars
    • typestringrequiredenum text
  • recipient_identity_key_hashstring1…512 chars

    Optional recipient identity key hash for identity-change protection.

  • reply_to_message_idstring1…512 chars

    Optional original Meta message ID to quote; no automatic retries.

  • sectionsobject[]required1…10 items
    • rowsobject[]required1…10 items
      • descriptionstringmax 72 chars
      • idstringrequired1…200 chars
      • titlestringrequired1…24 chars
    • titlestringrequired1…24 chars
  • textstringrequired1…4096 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_location

Function
Request
  • addressstringmax 1024 chars

    Optional address; 1024-character worker limit.

  • chat_idstringrequired1…136 chars

    International phone number or supported business-scoped user ID; native JIDs are not accepted.

  • latitudenumberrequired-90…90
  • longitudenumberrequired-180…180
  • namestringmax 1024 chars

    Optional place name; 1024-character worker limit.

  • recipient_identity_key_hashstring1…512 chars

    Optional recipient identity key hash for identity-change protection.

  • reply_to_message_idstring1…512 chars

    Optional original Meta message ID to quote; no automatic retries.

Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_marketing_template

Function
Request
  • chat_idstringrequired
  • componentsunknown[]
  • languagestringrequired
  • message_activity_sharingboolean

    Optional explicit per-message activity-sharing choice; omission preserves the WABA setting.

  • namestringrequired
  • product_policystringenum STRICT, CLOUD_API_FALLBACK

    Defaults to STRICT. CLOUD_API_FALLBACK explicitly permits Meta routing to standard Cloud API when marketing onboarding is incomplete.

  • recipient_identity_key_hashstringmax 512 chars

    Optional expected recipient identity hash for Meta identity-change checks.

  • reply_to_message_idstringmax 512 chars

    Optional Meta message ID to quote as a contextual reply.

Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_order_details

Function
Request
  • chat_idstringrequired1…136 chars
  • footerstringmax 60 chars
  • goods_typestringrequiredenum digital-goods, physical-goods
  • orderobject
    • catalog_idstring1…128 chars

      Meta catalog ID; 128-character worker limit.

    • discountobject
      • descriptionstringmax 60 chars
      • discount_program_namestringmax 60 chars
      • offsetintegerrequiredenum 100
      • valueintegerrequired0…9007199254740991
    • expirationobject
      • descriptionstringrequired1…120 chars
      • timestampstringrequired1…19 chars · /^[0-9]+$/

        Epoch-seconds string at least 300 seconds in the future.

    • itemsobject[]required1…100 items
      • amountobjectrequired
        Show 2 nested
        • offsetintegerrequiredenum 100
        • valueintegerrequired0…9007199254740991
      • namestringrequired1…60 chars
      • quantityintegerrequired1…9007199254740991
      • retailer_idstringrequired1…256 chars

        Catalog SKU/content ID; 256-character worker limit.

      • sale_amountobject
        Show 2 nested
        • offsetintegerrequiredenum 100
        • valueintegerrequired0…9007199254740991
    • shippingobject
      • descriptionstringmax 60 chars
      • offsetintegerrequiredenum 100
      • valueintegerrequired0…9007199254740991
    • statusstringenum pending
    • subtotalobjectrequired
      • offsetintegerrequiredenum 100
      • valueintegerrequired0…9007199254740991
    • taxobjectrequired
      • descriptionstringmax 60 chars
      • offsetintegerrequiredenum 100
      • valueintegerrequired0…9007199254740991
  • payment_settingsobject[]0…4 items
    • boletoobject
      • digitable_linestringrequired1…128 chars
    • offsite_card_payobject
      • credential_idstringrequired1…256 chars

        Opaque PSP credential reference, never a full card number or security code.

      • last_four_digitsstringrequired4…4 chars · /^[0-9]{4}$/
    • payment_linkobject
      • uristringrequired1…2048 chars

        HTTP(S) payment destination; never fetched by the worker.

    • pix_dynamic_codeobject
      • codestringrequired1…4096 chars
      • keystringrequired1…255 chars
      • key_typestringrequiredenum CPF, CNPJ, EMAIL, PHONE, EVP
      • merchant_namestringrequired1…255 chars
    • typestringrequiredenum pix_dynamic_code, payment_link, boleto, offsite_card_pay
  • recipient_identity_key_hashstring1…512 chars
  • reference_idstringrequired1…60 chars · /^[A-Za-z0-9_.-]+$/
  • reply_to_message_idstring1…512 chars
  • textstringrequiredmax 1024 chars
  • total_amountobjectrequired
    • offsetintegerrequiredenum 100
    • valueintegerrequired0…9007199254740991
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_order_status

Function
Request
  • chat_idstringrequired1…136 chars
  • footerstringmax 60 chars
  • orderobject
    • descriptionstringmax 120 chars
    • statusstringrequiredenum pending, processing, partially_shipped, shipped, completed, canceled
  • paymentobject
    • statusstringrequiredenum pending, captured, failed
    • timestampinteger0…9007199254740991
  • recipient_identity_key_hashstring1…512 chars
  • reference_idstringrequired1…60 chars · /^[A-Za-z0-9_.-]+$/
  • reply_to_message_idstring1…512 chars
  • textstringrequiredmax 1024 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_product

Function
Request
  • catalog_idstringrequired1…128 chars

    Meta catalog ID; 128-character worker limit.

  • chat_idstringrequired1…136 chars
  • footerstringmax 60 chars
  • product_retailer_idstringrequired1…256 chars

    Catalog SKU/content ID; 256-character worker limit.

  • recipient_identity_key_hashstring1…512 chars
  • reply_to_message_idstring1…512 chars
  • textstringmax 1024 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_products

Function
Request
  • catalog_idstringrequired1…128 chars

    Meta catalog ID; 128-character worker limit.

  • chat_idstringrequired1…136 chars
  • footerstringmax 60 chars
  • header_textstringrequired1…60 chars
  • recipient_identity_key_hashstring1…512 chars
  • reply_to_message_idstring1…512 chars
  • sectionsobject[]required1…10 items
    • product_retailer_idsstring[]required1…256 chars · 1…30 items
    • titlestringrequired1…24 chars
  • textstringrequiredmax 1024 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_reaction

Function
Request
  • chat_idstringrequired1…136 chars

    International phone number or supported business-scoped user ID; native JIDs are not accepted.

  • emojistringrequiredmax 128 chars

    One Unicode emoji sequence; empty string removes the reaction. Worker caps 128 UTF-8 bytes. Meta validates the exact emoji sequence.

  • message_idstringrequired1…512 chars

    Original incoming Meta message ID, without whitespace or control characters.

  • recipient_identity_key_hashstring1…512 chars

    Optional recipient identity key hash for identity-change protection.

Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_sticker

Function
Request
  • chat_idstringrequired

    International phone number or business-scoped user ID; native JIDs are rejected.

  • media_idstringrequired/^[0-9]{1,128}$/

    Meta media ID. Never a URL, native media key or host file path.

  • recipient_identity_key_hashstringmax 512 chars

    Optional expected recipient identity key hash.

  • reply_to_message_idstringmax 512 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_template

Function
Request
  • chat_idstringrequired
  • componentsunknown[]
  • languagestringrequired
  • namestringrequired
  • recipient_identity_key_hashstringmax 512 chars

    Optional expected recipient identity hash for Meta identity-change checks.

  • reply_to_message_idstringmax 512 chars

    Optional Meta message ID to quote as a contextual reply.

Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_text

Function
Request
  • chat_idstringrequired
  • preview_urlboolean
  • recipient_identity_key_hashstringmax 512 chars

    Optional expected recipient identity hash for Meta identity-change checks.

  • reply_to_message_idstringmax 512 chars

    Optional Meta message ID to quote as a contextual reply.

  • textstringrequired1…4096 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::send_video

Function
Request
  • captionstringmax 1024 chars
  • chat_idstringrequired

    International phone number or business-scoped user ID; native JIDs are rejected.

  • media_idstringrequired/^[0-9]{1,128}$/

    Meta media ID. Never a URL, native media key or host file path.

  • recipient_identity_key_hashstringmax 512 chars

    Optional expected recipient identity key hash.

  • reply_to_message_idstringmax 512 chars
Response
  • chat_idstringrequired
  • message_idstringrequired
  • message_statusstring
  • statusstringrequired

    Graph accepted the request; delivery is reported separately by webhook.

whatsapp::cloud::messages::typing

Function
Request
  • message_idstringrequired1…512 chars

    Original incoming Meta message ID, without whitespace or control characters.

Response
  • successbooleanrequired

whatsapp::cloud::phone_numbers::deregister

Function
Request
Empty object
Response
  • successbooleanrequired

whatsapp::cloud::phone_numbers::get

Function
Request
  • fieldsstring[]enum id, display_phone_number, verified_name, quality_rating, code_verification_status, name_status, …1…12 items
Response
  • code_verification_statusstringmax 8192 chars
  • display_phone_numberstringmax 8192 chars
  • idstringrequired1…128 chars · /^[0-9]+$/
  • is_official_business_accountboolean
  • name_statusstringmax 8192 chars
  • new_display_namestringmax 8192 chars
  • new_name_statusstringmax 8192 chars
  • platform_typestringmax 8192 chars
  • quality_ratingstringmax 8192 chars
  • statusstringmax 8192 chars
  • throughputobject
  • verified_namestringmax 8192 chars

whatsapp::cloud::phone_numbers::list

Function
Request
  • afterstring0…2048 chars
  • limitinteger1…100
Response
  • itemsobject[]requiredmax 1000 items
    • code_verification_statusstringmax 8192 chars
    • display_phone_numberstringmax 8192 chars
    • idstring1…128 chars · /^[0-9]+$/
    • is_official_business_accountboolean
    • name_statusstringmax 8192 chars
    • new_display_namestringmax 8192 chars
    • new_name_statusstringmax 8192 chars
    • platform_typestringmax 8192 chars
    • quality_ratingstringmax 8192 chars
    • statusstringmax 8192 chars
    • throughputobject
    • verified_namestringmax 8192 chars
  • next_cursorstringrequiredmax 2048 chars

whatsapp::cloud::phone_numbers::register

Function
Request
  • data_localization_regionstringenum AU, ID, IN, JP, SG, KR, …
  • pinstring· passwordrequired6…6 chars · /^[0-9]{6}$/
Response
  • successbooleanrequired

whatsapp::cloud::phone_numbers::request_code

Function
Request
  • code_methodstringrequiredenum SMS, VOICE
  • languagestringrequired2…12 chars · /^[a-z]{2,3}(_[A-Za-z0-9]{2,8})?$/
Response
  • successbooleanrequired

whatsapp::cloud::phone_numbers::set_display_name

Function
Request
  • new_display_namestringrequired1…512 chars
Response
  • successbooleanrequired

whatsapp::cloud::phone_numbers::set_pin

Function
Request
  • pinstring· passwordrequired6…6 chars · /^[0-9]{6}$/
Response
  • successbooleanrequired

whatsapp::cloud::phone_numbers::verify_code

Function
Request
  • codestring· passwordrequired1…16 chars · /^[0-9]+$/
Response
  • successbooleanrequired

whatsapp::cloud::profile::get

Function
Request
Empty object
Response
  • profileobjectrequired
    • aboutstringmax 8192 chars
    • addressstringmax 8192 chars
    • descriptionstringmax 8192 chars
    • emailstringmax 8192 chars
    • messaging_productstringmax 8192 chars
    • profile_picture_urlstringmax 8192 chars
    • verticalstringmax 8192 chars
    • websitesstring[]max 8192 chars · max 1000 items

whatsapp::cloud::profile::update

Function
Request
  • aboutstring0…139 chars
  • addressstring0…256 chars
  • descriptionstring0…512 chars
  • emailstring0…128 chars
  • profile_picture_handlestring0…8192 chars
  • verticalstringenum OTHER, AUTO, BEAUTY, APPAREL, EDU, ENTERTAIN, …
  • websitesstring[]1…256 chars · 0…2 items
Response
  • successbooleanrequired

whatsapp::cloud::qr_codes::create

Function
Request
  • generate_qr_imagestringenum PNG, SVG
  • prefilled_messagestringrequired0…140 chars
Response
  • codestringrequiredmax 8192 chars
  • deep_link_urlstringmax 8192 chars
  • prefilled_messagestringmax 8192 chars
  • qr_image_urlstringmax 8192 chars

whatsapp::cloud::qr_codes::delete

Function
Request
  • codestringrequired1…128 chars · /^[A-Za-z0-9]+$/
Response
  • successbooleanrequired

whatsapp::cloud::qr_codes::get

Function
Request
  • codestringrequired1…128 chars · /^[A-Za-z0-9]+$/
Response
  • itemsobject[]requiredmax 1000 items
    • codestringmax 8192 chars
    • deep_link_urlstringmax 8192 chars
    • prefilled_messagestringmax 8192 chars
    • qr_image_urlstringmax 8192 chars
  • next_cursorstringrequiredmax 2048 chars

whatsapp::cloud::qr_codes::list

Function
Request
  • afterstring0…2048 chars
  • limitinteger1…25
Response
  • itemsobject[]requiredmax 1000 items
    • codestringmax 8192 chars
    • deep_link_urlstringmax 8192 chars
    • prefilled_messagestringmax 8192 chars
    • qr_image_urlstringmax 8192 chars
  • next_cursorstringrequiredmax 2048 chars

whatsapp::cloud::qr_codes::update

Function
Request
  • codestringrequired1…128 chars · /^[A-Za-z0-9]+$/
  • generate_qr_imagestringenum PNG, SVG
  • prefilled_messagestringrequired0…140 chars
Response
  • codestringrequiredmax 8192 chars
  • deep_link_urlstringmax 8192 chars
  • prefilled_messagestringmax 8192 chars
  • qr_image_urlstringmax 8192 chars

whatsapp::cloud::status

Function
Request
Empty object
Response
  • access_token_setbooleanrequired
  • api_versionstringrequired
  • app_secret_setbooleanrequired
  • business_account_idstringrequired
  • configuredbooleanrequired

    Local readiness only. Does not imply remote authentication or delivery.

  • enabledbooleanrequired
  • missing_fieldsstring[]required
  • phone_number_idstringrequired
  • verify_token_setbooleanrequired
  • webhook_pathstringrequired
  • webhook_readybooleanrequired

whatsapp::cloud::subscriptions::list

Function
Request
  • afterstring0…2048 chars
  • limitinteger1…100
Response
  • itemsobject[]requiredmax 1000 items
    • override_callback_uristringmax 8192 chars
    • whatsapp_business_api_dataobject
      • idstringrequired1…128 chars · /^[0-9]+$/
      • linkstringmax 8192 chars
      • namestringrequiredmax 8192 chars
  • next_cursorstringrequiredmax 2048 chars

whatsapp::cloud::subscriptions::subscribe

Function
Request
  • override_callback_uristring1…2048 chars

    Public HTTPS callback override. Uses configured cloud.verify_token, never a token argument. Omit to use app default callback.

Response
  • successbooleanrequired

whatsapp::cloud::subscriptions::unsubscribe

Function
Request
Empty object
Response
  • successbooleanrequired

whatsapp::cloud::templates::create

Function
Request
  • allow_category_changeboolean
  • categorystringrequiredenum UTILITY, MARKETING, AUTHENTICATION
  • componentsobject[]required1…100 items
    • typestringrequired1…40 chars
  • cta_url_link_tracking_opted_outboolean
  • languagestringrequired2…12 chars · /^[a-z]{2,3}(_[A-Za-z0-9]{2,8})?$/
  • message_send_ttl_secondsinteger1…2592000
  • namestringrequired1…512 chars · /^[a-z0-9_]+$/
  • parameter_formatstringenum NAMED, POSITIONAL
Response
  • categorystringmax 8192 chars
  • componentsobject[]max 1000 items
    Empty object
  • idstringrequired1…128 chars · /^[0-9]+$/
  • languagestringmax 8192 chars
  • message_send_ttl_secondsintegermin 0
  • namestringmax 8192 chars
  • parameter_formatstringmax 8192 chars
  • quality_scoreobject
  • rejected_reasonstringmax 8192 chars
  • statusstringmax 8192 chars

whatsapp::cloud::templates::delete

Function
Request
  • namestringrequired1…512 chars · /^[a-z0-9_]+$/
  • template_idstring1…128 chars · /^[0-9]+$/
Response
  • successbooleanrequired

whatsapp::cloud::templates::get

Function
Request
  • template_idstringrequired1…128 chars · /^[0-9]+$/
Response
  • categorystringmax 8192 chars
  • componentsobject[]max 1000 items
    Empty object
  • idstringrequired1…128 chars · /^[0-9]+$/
  • languagestringmax 8192 chars
  • message_send_ttl_secondsintegermin 0
  • namestringmax 8192 chars
  • parameter_formatstringmax 8192 chars
  • quality_scoreobject
  • rejected_reasonstringmax 8192 chars
  • statusstringmax 8192 chars

whatsapp::cloud::templates::list

Function
Request
  • afterstring
  • limitinteger· uint1…100
Response
  • next_cursorstring
  • templatesobject[]required
    • categorystringrequired
    • componentsunknown[]
    • idstringrequired
    • languagestringrequired
    • namestringrequired
    • parameter_formatstring
    • statusstringrequired

whatsapp::cloud::templates::unpause

Function
Request
  • template_idstringrequired1…128 chars · /^[0-9]+$/
Response
  • successbooleanrequired

whatsapp::cloud::templates::update

Function
Request
  • allow_category_changeboolean
  • categorystringenum UTILITY, MARKETING, AUTHENTICATION
  • componentsobject[]1…100 items
    • typestringrequired1…40 chars
  • cta_url_link_tracking_opted_outboolean
  • message_send_ttl_secondsinteger1…2592000
  • parameter_formatstringenum NAMED, POSITIONAL
  • template_idstringrequired1…128 chars · /^[0-9]+$/
Response
  • successbooleanrequired

whatsapp::cloud::tunnel::changed

Function
Request
any of (6)
Variant 1
Empty object
Variant 2
itemsunknown[]
Variant 3
valuestring
Variant 4
valuenumber
Variant 5
valueboolean
Variant 6
valuenull
Response
  • acceptedbooleanrequired

whatsapp::cloud::tunnel::start

Function
Request
Empty object
Response
  • enabledbooleanrequired
  • errorstringrequired
  • public_urlstringrequired
  • statusstringrequiredenum stopped, starting, ready, reconnecting, failed, unavailable
  • tunnel_idstringrequired
  • webhook_pathstringrequired
  • webhook_urlstringrequired

whatsapp::cloud::tunnel::status

Function
Request
Empty object
Response
  • enabledbooleanrequired
  • errorstringrequired
  • public_urlstringrequired
  • statusstringrequiredenum stopped, starting, ready, reconnecting, failed, unavailable
  • tunnel_idstringrequired
  • webhook_pathstringrequired
  • webhook_urlstringrequired

whatsapp::cloud::tunnel::stop

Function
Request
Empty object
Response
  • enabledbooleanrequired
  • errorstringrequired
  • public_urlstringrequired
  • statusstringrequiredenum stopped, starting, ready, reconnecting, failed, unavailable
  • tunnel_idstringrequired
  • webhook_pathstringrequired
  • webhook_urlstringrequired

whatsapp::cloud::webhook::receive

Function
Request
any of (2)
Variant 1
  • headersany of
    any of (2)
    Variant 1
    Empty object
    Variant 2
    valuenull
  • request_bodyany of
    any of (2)
    Variant 1
    • access_keystring
    • channel_idstring
    • directionstring
    Variant 2
    valuenull
Variant 2
valuenull
Response
  • bodystringrequired
  • headersobjectrequired
  • status_codeintegerrequired

whatsapp::cloud::webhook::verify

Function
Request
any of (2)
Variant 1
  • query_paramsany of
    any of (2)
    Variant 1
    Empty object
    Variant 2
    valuenull
Variant 2
valuenull
Response
  • bodystringrequired
  • headersobjectrequired
  • status_codeintegerrequired

whatsapp::communities::create

Function
Request
  • allow_non_admin_sub_group_creationboolean
  • closedboolean
  • create_general_chatboolean
  • descriptionstring
  • namestringrequired
  • session_idstringrequired
Response
  • allow_admin_reportsbooleanrequired

    Null when the native client does not expose this value.

  • announcementbooleanrequired
  • creation_timeinteger· uint64min 0
  • creatorstring
  • descriptionstring
  • description_idstring
  • ephemeral_expiration_secondsinteger· uint32min 0
  • group_history_enabledbooleanrequired

    Null when the native client does not expose this value.

  • idstringrequired
  • is_announcement_subgroupbooleanrequired
  • is_communitybooleanrequired
  • is_general_chatbooleanrequired

    Null when the native client does not expose this value.

  • limit_sharing_enabledbooleanrequired

    Null when the native client does not expose this value.

  • lockedbooleanrequired
  • member_add_modestring
  • member_link_modestring
  • member_share_history_modestring
  • membership_approvalbooleanrequired
  • no_frequently_forwardedbooleanrequired

    Null when the native client does not expose this value.

  • parent_group_idstring
  • participant_countinteger· uint32min 0
  • participantsobject[]required
    • jidstringrequired
    • lidstring
    • participant_typestringrequired
    • phone_numberstring
    • usernamestring
  • subjectstring

whatsapp::communities::create_subgroup

Function
Request
  • community_idstringrequired
  • hiddenboolean
  • namestringrequired
  • participantsstring[]
  • session_idstringrequired
Response
  • allow_admin_reportsbooleanrequired

    Null when the native client does not expose this value.

  • announcementbooleanrequired
  • creation_timeinteger· uint64min 0
  • creatorstring
  • descriptionstring
  • description_idstring
  • ephemeral_expiration_secondsinteger· uint32min 0
  • group_history_enabledbooleanrequired

    Null when the native client does not expose this value.

  • idstringrequired
  • is_announcement_subgroupbooleanrequired
  • is_communitybooleanrequired
  • is_general_chatbooleanrequired

    Null when the native client does not expose this value.

  • limit_sharing_enabledbooleanrequired

    Null when the native client does not expose this value.

  • lockedbooleanrequired
  • member_add_modestring
  • member_link_modestring
  • member_share_history_modestring
  • membership_approvalbooleanrequired
  • no_frequently_forwardedbooleanrequired

    Null when the native client does not expose this value.

  • parent_group_idstring
  • participant_countinteger· uint32min 0
  • participantsobject[]required
    • jidstringrequired
    • lidstring
    • participant_typestringrequired
    • phone_numberstring
    • usernamestring
  • subjectstring

whatsapp::communities::get_subgroup

Function
Request
  • community_idstringrequired
  • session_idstringrequired
  • subgroup_idstringrequired
Response
  • allow_admin_reportsbooleanrequired

    Null when the native client does not expose this value.

  • announcementbooleanrequired
  • creation_timeinteger· uint64min 0
  • creatorstring
  • descriptionstring
  • description_idstring
  • ephemeral_expiration_secondsinteger· uint32min 0
  • group_history_enabledbooleanrequired

    Null when the native client does not expose this value.

  • idstringrequired
  • is_announcement_subgroupbooleanrequired
  • is_communitybooleanrequired
  • is_general_chatbooleanrequired

    Null when the native client does not expose this value.

  • limit_sharing_enabledbooleanrequired

    Null when the native client does not expose this value.

  • lockedbooleanrequired
  • member_add_modestring
  • member_link_modestring
  • member_share_history_modestring
  • membership_approvalbooleanrequired
  • no_frequently_forwardedbooleanrequired

    Null when the native client does not expose this value.

  • parent_group_idstring
  • participant_countinteger· uint32min 0
  • participantsobject[]required
    • jidstringrequired
    • lidstring
    • participant_typestringrequired
    • phone_numberstring
    • usernamestring
  • subjectstring

whatsapp::communities::list

Function
Request
  • session_idstringrequired
Response
itemsobject[]
  • idstringrequired
  • is_communitybooleanrequired
  • parent_group_idstring
  • participant_countinteger· uint32min 0
  • subjectstring

whatsapp::communities::participants

Function
Request
  • community_idstringrequired
  • session_idstringrequired
Response
itemsobject[]
  • jidstringrequired
  • lidstring
  • participant_typestringrequired
  • phone_numberstring
  • usernamestring

whatsapp::communities::subgroup_counts

Function
Request
  • community_idstringrequired
  • session_idstringrequired
Response
itemsobject[]
  • group_idstringrequired
  • participant_countinteger· uint32requiredmin 0

    Null when the native client does not expose this value.

whatsapp::communities::subgroups

Function
Request
  • community_idstringrequired
  • session_idstringrequired
Response
itemsobject[]
  • creation_timeinteger· uint64min 0
  • hiddenbooleanrequired

    Null when the native client does not expose this value.

  • idstringrequired
  • is_announcement_subgroupbooleanrequired
  • is_general_chatbooleanrequired

    Null when the native client does not expose this value.

  • ownerstring
  • participant_countinteger· uint32min 0
  • subjectstringrequired

whatsapp::config-status

Function
Request
any of (6)
Variant 1
Empty object
Variant 2
itemsunknown[]
Variant 3
valuestring
Variant 4
valuenumber
Variant 5
valueboolean
Variant 6
valuenull
Response
  • activeobjectrequired
    • cloudobjectrequired
      • access_tokenstringrequired
      • api_versionstringrequired
      • app_secretstringrequired
      • business_account_idstringrequired
      • enabledbooleanrequired
      • flow_handler_functionstring
      • flow_handler_namespacestring
      • flow_private_keystring
      • phone_number_idstringrequired
      • verify_tokenstringrequired
    • data_dirstringrequired
    • databaseobjectrequired
      • namestringrequired
      • namespacestringrequired
    • max_eventsintegerrequired
    • max_inbox_messagesintegerrequired
    • max_media_bytesintegerrequired
    • max_sessionsintegerrequired
    • operation_timeout_secsintegerrequired
    • shutdown_timeout_secsintegerrequired
  • environment_overridesobjectrequired
  • idstringrequired
  • last_errorone ofrequired
    one of (2)
    Variant 1
    valuestring
    Variant 2
    valuenull
  • last_outcomestringrequired
  • rejected_reloadsintegerrequired
  • restart_required_fieldsone ofrequired
    one of (2)
    Variant 1
    itemsstring[]
    Variant 2
    valuenull
  • sourcestringrequired

whatsapp::configuration-id

Function
Request
any of (6)
Variant 1
Empty object
Variant 2
itemsunknown[]
Variant 3
valuestring
Variant 4
valuenumber
Variant 5
valueboolean
Variant 6
valuenull
Response
  • idstringrequired

whatsapp::contacts::block

Function
Request
  • jidstringrequired
  • session_idstringrequired
Response
valuenull

whatsapp::contacts::blocked

Function
Request
  • session_idstringrequired
Response
itemsobject[]
  • jidstringrequired
  • timestampinteger· uint64min 0

whatsapp::contacts::check

Function
Request
  • jidsstring[]required
  • session_idstringrequired
Response
itemsobject[]
  • business_errorany of
    any of (2)
    Variant 1
    • backoffinteger· uint32min 0
    • codeinteger· uint16min 0
    • textstring
    Variant 2
    valuenull
  • contact_errorany of
    any of (2)
    Variant 1
    • backoffinteger· uint32min 0
    • codeinteger· uint16min 0
    • textstring
    Variant 2
    valuenull
  • is_businessbooleanrequired

    Null when the native client does not expose this value.

  • jidstringrequired
  • lidstring
  • lid_errorany of
    any of (2)
    Variant 1
    • backoffinteger· uint32min 0
    • codeinteger· uint16min 0
    • textstring
    Variant 2
    valuenull
  • phone_numberstring
  • registeredbooleanrequired
  • usernamestring
  • username_errorany of
    any of (2)
    Variant 1
    • backoffinteger· uint32min 0
    • codeinteger· uint16min 0
    • textstring
    Variant 2
    valuenull

whatsapp::contacts::info

Function
Request
  • jidsstring[]required
  • session_idstringrequired
Response
itemsobject[]
  • aboutstring
  • business_errorany of
    any of (2)
    Variant 1
    • backoffinteger· uint32min 0
    • codeinteger· uint16min 0
    • textstring
    Variant 2
    valuenull
  • devicesinteger[]· uint16requiredmin 0
  • devices_errorany of
    any of (2)
    Variant 1
    • backoffinteger· uint32min 0
    • codeinteger· uint16min 0
    • textstring
    Variant 2
    valuenull
  • is_businessbooleanrequired

    Null when the native client does not expose this value.

  • jidstringrequired
  • lidstring
  • lid_errorany of
    any of (2)
    Variant 1
    • backoffinteger· uint32min 0
    • codeinteger· uint16min 0
    • textstring
    Variant 2
    valuenull
  • picture_errorany of
    any of (2)
    Variant 1
    • backoffinteger· uint32min 0
    • codeinteger· uint16min 0
    • textstring
    Variant 2
    valuenull
  • picture_idstring
  • status_errorany of
    any of (2)
    Variant 1
    • backoffinteger· uint32min 0
    • codeinteger· uint16min 0
    • textstring
    Variant 2
    valuenull
  • usernamestring
  • username_errorany of
    any of (2)
    Variant 1
    • backoffinteger· uint32min 0
    • codeinteger· uint16min 0
    • textstring
    Variant 2
    valuenull

whatsapp::contacts::is_blocked

Function
Request
  • jidstringrequired
  • session_idstringrequired
Response
  • blockedbooleanrequired

whatsapp::contacts::picture

Function
Request
  • existing_idstring
  • jidstringrequired
  • previewboolean
  • session_idstringrequired
Response
one of (6)
Variant 1
  • direct_pathstring
  • hashstring
  • idstringrequired
  • statusstringrequiredenum found
  • urlstringrequired
Variant 2
  • statusstringrequiredenum unchanged
Variant 3
  • statusstringrequiredenum not_found
Variant 4
  • statusstringrequiredenum not_authorized
Variant 5
  • statusstringrequiredenum rate_overlimit
Variant 6
  • statusstringrequiredenum unknown

whatsapp::contacts::pictures

Function
Request
  • jidsstring[]required
  • session_idstringrequired
Response
itemsobject[]
  • errorstring
  • jidstringrequired
  • pictureany of
    any of (2)
    Variant 1
    one of (6)
    Variant 1
    • direct_pathstring
    • hashstring
    • idstringrequired
    • statusstringrequiredenum found
    • urlstringrequired
    Variant 2
    • statusstringrequiredenum unchanged
    Variant 3
    • statusstringrequiredenum not_found
    Variant 4
    • statusstringrequiredenum not_authorized
    Variant 5
    • statusstringrequiredenum rate_overlimit
    Variant 6
    • statusstringrequiredenum unknown
    Variant 2
    valuenull

whatsapp::contacts::resolve_phone

Function
Request
  • jidstringrequired
  • session_idstringrequired
Response
  • jidstringrequired
  • phone_numberstring

whatsapp::contacts::save

Function
Request
  • first_namestring
  • full_namestring
  • jidstringrequired
  • save_on_primary_addressbookboolean
  • session_idstringrequired
Response
valuenull

whatsapp::contacts::unblock

Function
Request
  • jidstringrequired
  • session_idstringrequired
Response
valuenull

whatsapp::events::poll

Function
Request
  • after_sequenceinteger· uint64min 0
  • limitinteger· uintmin 0
  • session_idstringrequired
Response
  • eventsobject[]required
    • dataunknownrequired
    • kindstringrequired
    • sequenceinteger· uint64requiredmin 0
    • session_idstringrequired
    • timestamp_msinteger· uint64requiredmin 0
  • next_sequenceinteger· uint64requiredmin 0

    Pass this value as `after_sequence` in the next poll.

  • truncatedbooleanrequired

    Earlier events have fallen outside the bounded queue or a process restarted.

whatsapp::groups::add_participants

Function
Request
  • group_idstringrequired
  • participantsstring[]required
  • session_idstringrequired
Response
itemsobject[]
  • errorstring
  • invite_codestring
  • invite_expirationinteger· uint64min 0
  • jidstringrequired
  • phone_numberstring
  • statusstring
  • usernamestring

whatsapp::groups::approve_requests

Function
Request
  • group_idstringrequired
  • participantsstring[]required
  • session_idstringrequired
Response
itemsobject[]
  • errorstring
  • invite_codestring
  • invite_expirationinteger· uint64min 0
  • jidstringrequired
  • phone_numberstring
  • statusstring
  • usernamestring

whatsapp::groups::create

Function
Request
  • participantsstring[]
  • session_idstringrequired
  • subjectstringrequired
Response
  • allow_admin_reportsbooleanrequired

    Null when the native client does not expose this value.

  • announcementbooleanrequired
  • creation_timeinteger· uint64min 0
  • creatorstring
  • descriptionstring
  • description_idstring
  • ephemeral_expiration_secondsinteger· uint32min 0
  • group_history_enabledbooleanrequired

    Null when the native client does not expose this value.

  • idstringrequired
  • is_announcement_subgroupbooleanrequired
  • is_communitybooleanrequired
  • is_general_chatbooleanrequired

    Null when the native client does not expose this value.

  • limit_sharing_enabledbooleanrequired

    Null when the native client does not expose this value.

  • lockedbooleanrequired
  • member_add_modestring
  • member_link_modestring
  • member_share_history_modestring
  • membership_approvalbooleanrequired
  • no_frequently_forwardedbooleanrequired

    Null when the native client does not expose this value.

  • parent_group_idstring
  • participant_countinteger· uint32min 0
  • participantsobject[]required
    • jidstringrequired
    • lidstring
    • participant_typestringrequired
    • phone_numberstring
    • usernamestring
  • subjectstring

whatsapp::groups::demote_participants

Function
Request
  • group_idstringrequired
  • participantsstring[]required
  • session_idstringrequired
Response
itemsobject[]
  • errorstring
  • invite_codestring
  • invite_expirationinteger· uint64min 0
  • jidstringrequired
  • phone_numberstring
  • statusstring
  • usernamestring

whatsapp::groups::get

Function
Request
  • group_idstringrequired
  • session_idstringrequired
Response
  • allow_admin_reportsbooleanrequired

    Null when the native client does not expose this value.

  • announcementbooleanrequired
  • creation_timeinteger· uint64min 0
  • creatorstring
  • descriptionstring
  • description_idstring
  • ephemeral_expiration_secondsinteger· uint32min 0
  • group_history_enabledbooleanrequired

    Null when the native client does not expose this value.

  • idstringrequired
  • is_announcement_subgroupbooleanrequired
  • is_communitybooleanrequired
  • is_general_chatbooleanrequired

    Null when the native client does not expose this value.

  • limit_sharing_enabledbooleanrequired

    Null when the native client does not expose this value.

  • lockedbooleanrequired
  • member_add_modestring
  • member_link_modestring
  • member_share_history_modestring
  • membership_approvalbooleanrequired
  • no_frequently_forwardedbooleanrequired

    Null when the native client does not expose this value.

  • parent_group_idstring
  • participant_countinteger· uint32min 0
  • participantsobject[]required
    • jidstringrequired
    • lidstring
    • participant_typestringrequired
    • phone_numberstring
    • usernamestring
  • subjectstring

whatsapp::groups::invite_info

Function
Request
  • codestringrequired
  • session_idstringrequired
Response
  • allow_admin_reportsbooleanrequired

    Null when the native client does not expose this value.

  • announcementbooleanrequired
  • creation_timeinteger· uint64min 0
  • creatorstring
  • descriptionstring
  • description_idstring
  • ephemeral_expiration_secondsinteger· uint32min 0
  • group_history_enabledbooleanrequired

    Null when the native client does not expose this value.

  • idstringrequired
  • is_announcement_subgroupbooleanrequired
  • is_communitybooleanrequired
  • is_general_chatbooleanrequired

    Null when the native client does not expose this value.

  • limit_sharing_enabledbooleanrequired

    Null when the native client does not expose this value.

  • lockedbooleanrequired
  • member_add_modestring
  • member_link_modestring
  • member_share_history_modestring
  • membership_approvalbooleanrequired
  • no_frequently_forwardedbooleanrequired

    Null when the native client does not expose this value.

  • parent_group_idstring
  • participant_countinteger· uint32min 0
  • participantsobject[]required
    • jidstringrequired
    • lidstring
    • participant_typestringrequired
    • phone_numberstring
    • usernamestring
  • subjectstring

whatsapp::groups::join

Function
Request
  • codestringrequired
  • session_idstringrequired
Response
  • group_idstringrequired
  • pending_approvalbooleanrequired

    Null when the native client does not expose this value.

whatsapp::groups::leave

Function
Request
  • group_idstringrequired
  • session_idstringrequired
Response
valuenull

whatsapp::groups::list

Function
Request
  • session_idstringrequired
Response
itemsobject[]
  • idstringrequired
  • is_communitybooleanrequired
  • parent_group_idstring
  • participant_countinteger· uint32min 0
  • subjectstring

whatsapp::groups::membership_requests

Function
Request
  • group_idstringrequired
  • session_idstringrequired
Response
itemsobject[]
  • jidstringrequired
  • request_timeinteger· uint64min 0

whatsapp::groups::picture

Function
Request
  • existing_idstring
  • jidstringrequired
  • previewboolean
  • session_idstringrequired
Response
one of (6)
Variant 1
  • direct_pathstring
  • hashstring
  • idstringrequired
  • statusstringrequiredenum found
  • urlstringrequired
Variant 2
  • statusstringrequiredenum unchanged
Variant 3
  • statusstringrequiredenum not_found
Variant 4
  • statusstringrequiredenum not_authorized
Variant 5
  • statusstringrequiredenum rate_overlimit
Variant 6
  • statusstringrequiredenum unknown

whatsapp::groups::promote_participants

Function
Request
  • group_idstringrequired
  • participantsstring[]required
  • session_idstringrequired
Response
itemsobject[]
  • errorstring
  • invite_codestring
  • invite_expirationinteger· uint64min 0
  • jidstringrequired
  • phone_numberstring
  • statusstring
  • usernamestring

whatsapp::groups::reject_requests

Function
Request
  • group_idstringrequired
  • participantsstring[]required
  • session_idstringrequired
Response
itemsobject[]
  • errorstring
  • invite_codestring
  • invite_expirationinteger· uint64min 0
  • jidstringrequired
  • phone_numberstring
  • statusstring
  • usernamestring

whatsapp::groups::remove_participants

Function
Request
  • group_idstringrequired
  • participantsstring[]required
  • session_idstringrequired
Response
itemsobject[]
  • errorstring
  • invite_codestring
  • invite_expirationinteger· uint64min 0
  • jidstringrequired
  • phone_numberstring
  • statusstring
  • usernamestring

whatsapp::groups::remove_picture

Function
Request
  • group_idstringrequired
  • session_idstringrequired
Response
  • idstringrequired

whatsapp::groups::revoke_invite

Function
Request
  • group_idstringrequired
  • session_idstringrequired
Response
  • urlstringrequired

whatsapp::groups::set_announcement

Function
Request
  • enabledbooleanrequired
  • group_idstringrequired
  • session_idstringrequired
Response
valuenull

whatsapp::groups::set_description

Function
Request
  • descriptionstring
  • group_idstringrequired
  • previous_description_idstring

    An existing description version; omit to fetch the current version.

  • session_idstringrequired
Response
valuenull

whatsapp::groups::set_ephemeral

Function
Request
  • expiration_secondsinteger· uint32requiredmin 0
  • group_idstringrequired
  • session_idstringrequired
Response
valuenull

whatsapp::groups::set_locked

Function
Request
  • enabledbooleanrequired
  • group_idstringrequired
  • session_idstringrequired
Response
valuenull

whatsapp::groups::set_member_add_mode

Function
Request
  • all_membersbooleanrequired

    False permits admins only; true permits all members.

  • group_idstringrequired
  • session_idstringrequired
Response
valuenull

whatsapp::groups::set_membership_approval

Function
Request
  • enabledbooleanrequired
  • group_idstringrequired
  • session_idstringrequired
Response
valuenull

whatsapp::groups::set_picture

Function
Request
  • group_idstringrequired
  • jpeg_base64stringrequired
  • session_idstringrequired
Response
  • idstringrequired

whatsapp::groups::set_subject

Function
Request
  • group_idstringrequired
  • session_idstringrequired
  • subjectstringrequired
Response
valuenull

whatsapp::labels::add_chat

Function
Request
  • chat_idstringrequired
  • label_idstringrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::labels::add_message

Function
Request
  • chat_idstringrequired
  • label_idstringrequired
  • message_idstringrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::labels::delete

Function
Request
  • label_idstringrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::labels::remove_chat

Function
Request
  • chat_idstringrequired
  • label_idstringrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::labels::remove_message

Function
Request
  • chat_idstringrequired
  • label_idstringrequired
  • message_idstringrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::labels::set

Function
Request
  • colorinteger· int32required
  • label_idstringrequired
  • namestringrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::media::download

Function
Request
  • direct_pathstringrequired
  • file_enc_sha256_base64string
  • file_lengthinteger· uint64requiredmin 0
  • file_sha256_base64stringrequired
  • media_key_base64string

    Omit both encryption fields only for plaintext channel media.

  • media_typestringrequiredenum image, video, audio, document, sticker
  • session_idstringrequired
Response
  • data_base64stringrequired
  • file_lengthinteger· uintrequiredmin 0

whatsapp::media::send

Function
Request
  • chat_idstringrequired
  • mediaobjectrequired
    • captionstring
    • data_base64stringrequired
    • duration_secondsinteger· uint32min 0
    • file_namestring
    • gif_playbackboolean
    • media_typestringrequiredenum image, video, audio, document, sticker
    • mimetypestring
    • thumbnail_base64string
    • voice_noteboolean

      Audio is already encoded; the worker never invokes codecs.

  • session_idstringrequired
Response
  • chat_idstringrequired
  • message_idstringrequired
  • recipient_fanoutany of
    any of (2)
    Variant 1
    • addressedinteger· uintrequiredmin 0
    • encryptedinteger· uintrequiredmin 0
    • had_unregistered_devicebooleanrequired
    • skipped_primarybooleanrequired
    Variant 2
    valuenull

whatsapp::media::upload

Function
Request
  • data_base64stringrequired
  • media_typestringrequiredenum image, video, audio, document, sticker
  • session_idstringrequired
Response
  • direct_pathstringrequired
  • file_enc_sha256_base64stringrequired
  • file_lengthinteger· uint64requiredmin 0
  • file_sha256_base64stringrequired
  • media_key_base64stringrequired
  • media_key_timestampinteger· int64required
  • media_typestringrequiredenum image, video, audio, document, sticker
  • urlstringrequired

whatsapp::messages::delete

Function
Request
  • chat_idstringrequired
  • message_idstringrequired
  • original_sender_idstring

    Set only when revoking another member's message as a group admin.

  • session_idstringrequired
Response
  • chat_idstringrequired
  • message_idstringrequired
  • recipient_fanoutany of
    any of (2)
    Variant 1
    • addressedinteger· uintrequiredmin 0
    • encryptedinteger· uintrequiredmin 0
    • had_unregistered_devicebooleanrequired
    • skipped_primarybooleanrequired
    Variant 2
    valuenull

whatsapp::messages::delete_for_me

Function
Request
  • delete_mediabooleanrequired
  • message_timestamp_msinteger· int64
  • session_idstringrequired
  • targetobjectrequired

    Keeps an original sender's namespace, including LID, for message operations.

    • chat_idstringrequired
    • from_mebooleanrequired
    • message_idstringrequired
    • participant_idstring
Response
  • appliedbooleanrequired

whatsapp::messages::edit

Function
Request
  • chat_idstringrequired
  • message_idstringrequired
  • session_idstringrequired
  • textstringrequired
Response
  • chat_idstringrequired
  • message_idstringrequired
  • recipient_fanoutany of
    any of (2)
    Variant 1
    • addressedinteger· uintrequiredmin 0
    • encryptedinteger· uintrequiredmin 0
    • had_unregistered_devicebooleanrequired
    • skipped_primarybooleanrequired
    Variant 2
    valuenull

whatsapp::messages::keep

Function
Request
  • keepbooleanrequired
  • session_idstringrequired
  • targetobjectrequired

    Keeps an original sender's namespace, including LID, for message operations.

    • chat_idstringrequired
    • from_mebooleanrequired
    • message_idstringrequired
    • participant_idstring
Response
  • chat_idstringrequired
  • message_idstringrequired
  • recipient_fanoutany of
    any of (2)
    Variant 1
    • addressedinteger· uintrequiredmin 0
    • encryptedinteger· uintrequiredmin 0
    • had_unregistered_devicebooleanrequired
    • skipped_primarybooleanrequired
    Variant 2
    valuenull

whatsapp::messages::list

Function
Request
  • chat_idstringrequired
  • cursorstring
  • limitinteger· uintmin 0
  • session_idstringrequired
Response
  • coverageobjectrequired
    • capture_started_at_msinteger· int64required
    • last_history_sync_at_msinteger· int64
    • last_history_sync_progressinteger· uint32min 0
    • message_limitinteger· uintrequiredmin 0
    • retention_truncatedbooleanrequired
  • messagesobject[]required

    Newest first. A cursor loads older locally retained messages.

    • chat_idstringrequired
    • from_mebooleanrequired
    • kindstringrequired
    • message_idstringrequired
    • sender_idstringrequired
    • sender_namestring
    • sourcestringrequired
    • statusstring
    • textstringrequired
    • timestamp_msinteger· int64required
  • next_cursorstring

whatsapp::messages::mark_played

Function
Request
  • chat_idstringrequired
  • message_idsstring[]required
  • sender_idstring
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::messages::mark_read

Function
Request
  • chat_idstringrequired
  • message_idsstring[]required
  • sender_idstring
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::messages::pin

Function
Request
  • durationstringrequiredenum hours24, days7, days30
  • session_idstringrequired
  • targetobjectrequired

    Keeps an original sender's namespace, including LID, for message operations.

    • chat_idstringrequired
    • from_mebooleanrequired
    • message_idstringrequired
    • participant_idstring
Response
  • chat_idstringrequired
  • message_idstringrequired
  • recipient_fanoutany of
    any of (2)
    Variant 1
    • addressedinteger· uintrequiredmin 0
    • encryptedinteger· uintrequiredmin 0
    • had_unregistered_devicebooleanrequired
    • skipped_primarybooleanrequired
    Variant 2
    valuenull

whatsapp::messages::react

Function
Request
  • emojistringrequired

    Empty removes this account's reaction.

  • session_idstringrequired
  • targetobjectrequired

    Keeps an original sender's namespace, including LID, for message operations.

    • chat_idstringrequired
    • from_mebooleanrequired
    • message_idstringrequired
    • participant_idstring
Response
  • chat_idstringrequired
  • message_idstringrequired
  • recipient_fanoutany of
    any of (2)
    Variant 1
    • addressedinteger· uintrequiredmin 0
    • encryptedinteger· uintrequiredmin 0
    • had_unregistered_devicebooleanrequired
    • skipped_primarybooleanrequired
    Variant 2
    valuenull

whatsapp::messages::reply

Function
Request
  • chat_idstringrequired
  • message_idstringrequired
  • quoted_textstringrequired
  • sender_idstringrequired
  • session_idstringrequired
  • textstringrequired
Response
  • chat_idstringrequired
  • message_idstringrequired
  • recipient_fanoutany of
    any of (2)
    Variant 1
    • addressedinteger· uintrequiredmin 0
    • encryptedinteger· uintrequiredmin 0
    • had_unregistered_devicebooleanrequired
    • skipped_primarybooleanrequired
    Variant 2
    valuenull

whatsapp::messages::request_history

Function
Request
  • chat_idstringrequired
  • countinteger· uintmin 0
  • session_idstringrequired
Response
  • request_idstringrequired
  • requested_countinteger· uintrequiredmin 0

whatsapp::messages::send_contact

Function
Request
  • chat_idstringrequired
  • display_namestringrequired
  • session_idstringrequired
  • vcardstringrequired

    A complete vCard, supplied by the caller.

Response
  • chat_idstringrequired
  • message_idstringrequired
  • recipient_fanoutany of
    any of (2)
    Variant 1
    • addressedinteger· uintrequiredmin 0
    • encryptedinteger· uintrequiredmin 0
    • had_unregistered_devicebooleanrequired
    • skipped_primarybooleanrequired
    Variant 2
    valuenull

whatsapp::messages::send_location

Function
Request
  • addressstring
  • chat_idstringrequired
  • latitudenumber· doublerequired
  • longitudenumber· doublerequired
  • namestring
  • session_idstringrequired
Response
  • chat_idstringrequired
  • message_idstringrequired
  • recipient_fanoutany of
    any of (2)
    Variant 1
    • addressedinteger· uintrequiredmin 0
    • encryptedinteger· uintrequiredmin 0
    • had_unregistered_devicebooleanrequired
    • skipped_primarybooleanrequired
    Variant 2
    valuenull

whatsapp::messages::send_poll

Function
Request
  • chat_idstringrequired
  • namestringrequired
  • optionsstring[]required
  • selectable_countinteger· uint32requiredmin 0
  • session_idstringrequired
Response
  • messageobjectrequired
    • chat_idstringrequired
    • message_idstringrequired
    • recipient_fanoutany of
      any of (2)
      Variant 1
      • addressedinteger· uintrequiredmin 0
      • encryptedinteger· uintrequiredmin 0
      • had_unregistered_devicebooleanrequired
      • skipped_primarybooleanrequired
      Variant 2
      valuenull
  • message_secret_base64stringrequired

whatsapp::messages::send_text

Function
Request
  • chat_idstringrequired
  • session_idstringrequired
  • textstringrequired
Response
  • chat_idstringrequired
  • message_idstringrequired
  • recipient_fanoutany of
    any of (2)
    Variant 1
    • addressedinteger· uintrequiredmin 0
    • encryptedinteger· uintrequiredmin 0
    • had_unregistered_devicebooleanrequired
    • skipped_primarybooleanrequired
    Variant 2
    valuenull

whatsapp::messages::star

Function
Request
  • session_idstringrequired
  • targetobjectrequired

    Keeps an original sender's namespace, including LID, for message operations.

    • chat_idstringrequired
    • from_mebooleanrequired
    • message_idstringrequired
    • participant_idstring
Response
  • appliedbooleanrequired

whatsapp::messages::unpin

Function
Request
  • session_idstringrequired
  • targetobjectrequired

    Keeps an original sender's namespace, including LID, for message operations.

    • chat_idstringrequired
    • from_mebooleanrequired
    • message_idstringrequired
    • participant_idstring
Response
  • chat_idstringrequired
  • message_idstringrequired
  • recipient_fanoutany of
    any of (2)
    Variant 1
    • addressedinteger· uintrequiredmin 0
    • encryptedinteger· uintrequiredmin 0
    • had_unregistered_devicebooleanrequired
    • skipped_primarybooleanrequired
    Variant 2
    valuenull

whatsapp::messages::unstar

Function
Request
  • session_idstringrequired
  • targetobjectrequired

    Keeps an original sender's namespace, including LID, for message operations.

    • chat_idstringrequired
    • from_mebooleanrequired
    • message_idstringrequired
    • participant_idstring
Response
  • appliedbooleanrequired

whatsapp::messages::vote_poll

Function
Request
  • chat_idstringrequired
  • creator_idstringrequired
  • message_idstringrequired
  • message_secret_base64stringrequired
  • option_namesstring[]required
  • session_idstringrequired
Response
  • chat_idstringrequired
  • message_idstringrequired
  • recipient_fanoutany of
    any of (2)
    Variant 1
    • addressedinteger· uintrequiredmin 0
    • encryptedinteger· uintrequiredmin 0
    • had_unregistered_devicebooleanrequired
    • skipped_primarybooleanrequired
    Variant 2
    valuenull

whatsapp::newsletters::create

Function
Request
  • descriptionstring
  • namestringrequired
  • session_idstringrequired
Response
  • creation_timeinteger· uint64min 0
  • descriptionstring
  • follower_activity_mutedboolean
  • invite_codestring
  • mutedboolean
  • namestringrequired
  • newsletter_idstringrequired
  • picture_urlstring
  • preview_urlstring
  • rolestring
  • statestringrequired
  • subscriber_countinteger· uint64requiredmin 0
  • verificationstringrequired

whatsapp::newsletters::edit

Function
Request
  • message_idstringrequired
  • newsletter_idstringrequired
  • session_idstringrequired
  • textstringrequired
Response
  • appliedbooleanrequired

whatsapp::newsletters::get

Function
Request
  • newsletter_idstringrequired
  • session_idstringrequired
Response
  • creation_timeinteger· uint64min 0
  • descriptionstring
  • follower_activity_mutedboolean
  • invite_codestring
  • mutedboolean
  • namestringrequired
  • newsletter_idstringrequired
  • picture_urlstring
  • preview_urlstring
  • rolestring
  • statestringrequired
  • subscriber_countinteger· uint64requiredmin 0
  • verificationstringrequired

whatsapp::newsletters::get_by_invite

Function
Request
  • invite_codestringrequired
  • session_idstringrequired
Response
  • creation_timeinteger· uint64min 0
  • descriptionstring
  • follower_activity_mutedboolean
  • invite_codestring
  • mutedboolean
  • namestringrequired
  • newsletter_idstringrequired
  • picture_urlstring
  • preview_urlstring
  • rolestring
  • statestringrequired
  • subscriber_countinteger· uint64requiredmin 0
  • verificationstringrequired

whatsapp::newsletters::join

Function
Request
  • newsletter_idstringrequired
  • session_idstringrequired
Response
  • creation_timeinteger· uint64min 0
  • descriptionstring
  • follower_activity_mutedboolean
  • invite_codestring
  • mutedboolean
  • namestringrequired
  • newsletter_idstringrequired
  • picture_urlstring
  • preview_urlstring
  • rolestring
  • statestringrequired
  • subscriber_countinteger· uint64requiredmin 0
  • verificationstringrequired

whatsapp::newsletters::leave

Function
Request
  • newsletter_idstringrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::newsletters::list

Function
Request
  • session_idstringrequired
Response
itemsobject[]
  • creation_timeinteger· uint64min 0
  • descriptionstring
  • follower_activity_mutedboolean
  • invite_codestring
  • mutedboolean
  • namestringrequired
  • newsletter_idstringrequired
  • picture_urlstring
  • preview_urlstring
  • rolestring
  • statestringrequired
  • subscriber_countinteger· uint64requiredmin 0
  • verificationstringrequired

whatsapp::newsletters::messages

Function
Request
  • before_server_idinteger· uint64min 0
  • countinteger· uint32requiredmin 0
  • newsletter_idstringrequired
  • session_idstringrequired
Response
itemsobject[]
  • admin_profileany of
    any of (2)
    Variant 1
    • idstring
    • namestringrequired
    • picture_direct_pathstring
    • picture_idstring
    Variant 2
    valuenull
  • contentunknown

    Native protobuf JSON content; absent on revoked messages.

  • forwards_countinteger· uint64min 0
  • is_senderbooleanrequired

    Null when the native client does not expose this value.

  • last_edit_timestamp_msinteger· uint64min 0
  • media_typestring
  • message_idstringrequired
  • message_typestringrequired
  • original_timestampinteger· uint64min 0
  • poll_typestring
  • reactionsobject[]required

    Null when the native client does not expose this value.

    • countinteger· uint64requiredmin 0
    • emojistringrequired
  • responses_countinteger· uint64min 0
  • server_idinteger· uint64requiredmin 0
  • timestampinteger· uint64requiredmin 0

    Null when the native client does not expose this value.

  • views_countinteger· uint64min 0
  • votesobject[]required

    Null when the native client does not expose this value.

    • countinteger· uint64requiredmin 0
    • option_hash_base64stringrequired

whatsapp::newsletters::mute_updates

Function
Request
  • mutedbooleanrequired
  • newsletter_idstringrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::newsletters::react

Function
Request
  • emojistringrequired
  • newsletter_idstringrequired
  • server_idinteger· uint64requiredmin 0
  • session_idstringrequired
Response
  • stanza_idstringrequired

whatsapp::newsletters::revoke

Function
Request
  • message_idstringrequired
  • newsletter_idstringrequired
  • session_idstringrequired
Response
  • appliedbooleanrequired

whatsapp::newsletters::subscribe_updates

Function
Request
  • newsletter_idstringrequired
  • session_idstringrequired
Response
  • duration_secondsinteger· uint64requiredmin 0

whatsapp::on-config-change

Function
Request
any of (6)
Variant 1
Empty object
Variant 2
itemsunknown[]
Variant 3
valuestring
Variant 4
valuenumber
Variant 5
valueboolean
Variant 6
valuenull
Response
  • okbooleanrequired

whatsapp::privacy::get

Function
Request
  • session_idstringrequired
Response
itemsobject[]
  • categorystringrequired
  • valuestringrequired

whatsapp::privacy::set

Function
Request
  • categorystringrequired
  • session_idstringrequired
  • valuestringrequired
Response
  • dhashstring

whatsapp::privacy::set_disappearing_default

Function
Request
  • expiration_secondsinteger· uint32requiredmin 0
  • session_idstringrequired
Response
valuenull

whatsapp::profile::remove_picture

Function
Request
  • session_idstringrequired
Response
  • idstringrequired

whatsapp::profile::set_about

Function
Request
  • session_idstringrequired
  • textstringrequired
Response
valuenull

whatsapp::profile::set_name

Function
Request
  • session_idstringrequired
  • textstringrequired
Response
valuenull

whatsapp::profile::set_picture

Function
Request
  • jpeg_base64stringrequired
  • session_idstringrequired
Response
  • idstringrequired

whatsapp::sessions::create

Function
Request
  • session_idstringrequired
Response
  • created_at_msinteger· uint64requiredmin 0
  • session_idstringrequired
  • statusstringrequiredenum stopped, starting, pairing, connected, disconnected, stopping, …

whatsapp::sessions::delete

Function
Request
  • session_idstringrequired
Response
  • created_at_msinteger· uint64requiredmin 0
  • session_idstringrequired
  • statusstringrequiredenum stopped, starting, pairing, connected, disconnected, stopping, …

whatsapp::sessions::get

Function
Request
  • session_idstringrequired
Response
  • created_at_msinteger· uint64requiredmin 0
  • session_idstringrequired
  • statusstringrequiredenum stopped, starting, pairing, connected, disconnected, stopping, …

whatsapp::sessions::list

Function
Request
Empty object
Response
itemsobject[]
  • created_at_msinteger· uint64requiredmin 0
  • session_idstringrequired
  • statusstringrequiredenum stopped, starting, pairing, connected, disconnected, stopping, …

whatsapp::sessions::logout

Function
Request
  • session_idstringrequired
Response
  • created_at_msinteger· uint64requiredmin 0
  • session_idstringrequired
  • statusstringrequiredenum stopped, starting, pairing, connected, disconnected, stopping, …

whatsapp::sessions::pair_code

Function
Request
  • phone_numberstringrequired
  • session_idstringrequired
Response
  • codestringrequired
  • expires_at_msinteger· uint64requiredmin 0

whatsapp::sessions::qr

Function
Request
  • session_idstringrequired
Response
any of (2)
Variant 1
  • codestringrequired
  • expires_at_msinteger· uint64requiredmin 0
Variant 2
valuenull

whatsapp::sessions::start

Function
Request
  • session_idstringrequired
Response
  • created_at_msinteger· uint64requiredmin 0
  • session_idstringrequired
  • statusstringrequiredenum stopped, starting, pairing, connected, disconnected, stopping, …

whatsapp::sessions::stop

Function
Request
  • session_idstringrequired
Response
  • created_at_msinteger· uint64requiredmin 0
  • session_idstringrequired
  • statusstringrequiredenum stopped, starting, pairing, connected, disconnected, stopping, …

whatsapp::ui-content

Function
Request
  • pathstringrequired
Response
  • contentstringrequired
  • content_typestringrequired

Triggers2

whatsapp::cloud::events

Trigger

Filtered WhatsApp Cloud API messages, delivery statuses, and optional account/group/calling webhook events. Publishes verified events after durable deduplication; messages are also saved to the local archive. ## Register a subscription 1. Register a callback function that accepts the event object below. Replace `automation::on-whatsapp-message` with that function's ID and the example `chat_ids` with the contacts you want to monitor. 2. Call `engine::register_trigger` in the `default` namespace with the following JSON. Use an initialized caller connection in the callback function's namespace. `trigger_namespace` selects this WhatsApp provider, not the callback namespace. With the CLI, `III_NAMESPACE` sets the connection namespace; `--namespace default` routes the call to the engine function. For a newly connected Go SDK client, first wait until `engine::workers::list` shows that client in the intended namespace; `Connect` can return before its namespace is announced. ```json { "trigger_type": "whatsapp::cloud::events", "trigger_namespace": "default", "function_id": "automation::on-whatsapp-message", "config": { "chat_ids": ["+15550000009"], "message_types": ["text"] }, "metadata": {"workflow": "customer-support"} } ``` 3. Save the returned `id`. Call `engine::registered-triggers::info` with `{"id":"<returned-id>"}` and check that `status` is `active` and `function` identifies the intended callback and namespace. Active confirms the provider binding; it does not guarantee the callback exists. Registration does not replay old messages. 4. Remove the subscription with `engine::unregister_trigger` and `{"id":"<returned-id>"}`. Function-path registrations survive the calling connection closing; explicitly unregister them when finished. Callback metadata is separate from the event payload. Callback return values do not send replies to WhatsApp. ## Filter configuration Every field in `config` is optional. Always supply a JSON object; `{}` receives all incoming messages for the configured Cloud account. Unknown fields are rejected. Populated fields combine with AND; values within each list combine with OR. | Field | Values and behavior | | --- | --- | | `kinds` | List: `message.received`, `message.status`, `webhook.received`. Omitted, null or empty defaults to only `message.received`. | | `chat_ids` | Contact phone numbers such as `+15550000009`, business-scoped IDs such as `BR.ENT.Abc123`, or `group:<raw Cloud group ID>`. Use IDs from `whatsapp::cloud::chats::list`. Native JIDs are not supported. | | `sender_ids` | List of sender IDs in the same format. Applies to incoming messages. | | `message_types` | List of exact raw Meta types, such as `text`, `image`, `audio`, `interactive` or `button`. Names must start with a lowercase letter and contain 1–64 lowercase letters, digits or underscores. | | `statuses` | List: `sent`, `delivered`, `read`, `failed`. Also set `kinds` to include `message.status`. | | `fields` | Exact Meta webhook fields, such as `messages`, `message_template_status_update`, `calls`, or `group_lifecycle_update`. Administrative events require `kinds: ["webhook.received"]`. | | `events` | Exact administrative event names, such as `APPROVED`, `group_create`, or a calling event name. | | `group_ids` | Raw Cloud group IDs without the `group:` prefix. Matches group messages, receipts, and metadata events. | | `participant_ids` | Normalized participants identified by group delivery/read receipts. Also select `message.status`. | | `business_account_id` | Exact WABA ID, a numeric string of at most 32 digits. | | `phone_number_id` | Exact Phone Number ID, a numeric string of at most 32 digits. | Empty lists impose no restriction except the received-only default for `kinds`. Empty account ID strings impose no restriction. Each list allows at most 128 values; the entire filter is limited to 64 KiB. Status events have no sender or message type, so populated `sender_ids` or `message_types` exclude them. To receive read and failed receipts for one contact, replace `config` above with: ```json { "kinds": ["message.status"], "chat_ids": ["+15550000009"], "statuses": ["read", "failed"] } ``` ## Callback payload ```json { "kind": "message.received", "business_account_id": "123", "phone_number_id": "456", "message_id": "wamid.example", "chat_id": "+15550000009", "sender_id": "+15550000009", "message_type": "text", "text": "Hello", "timestamp_ms": 1700000000000, "data": { "id": "wamid.example", "from": "15550000009", "timestamp": "1700000000", "type": "text", "text": {"body": "Hello"} } } ``` `message.status` uses the same account, message, chat and timestamp fields plus `status`; sender, message type and text may be absent. `timestamp_ms` is Meta's timestamp in milliseconds. `data` contains the single original message/status object, not the whole webhook. Events are capped at 64 KiB; oversized content uses `data: {"content_omitted":true}` with a clipped preview. ## Delivery and setup Configure Cloud API credentials and the Meta webhook first; `whatsapp::cloud::status` reports local setup. This trigger does not configure Meta or subscribe to linked-device events (`whatsapp::events`). Local sends do not emit `message.received`; Meta receipts can emit `message.status`. Duplicate messages and identical status updates are suppressed within retained deduplication history. Delivery is best effort, without callback retries or replay; queue overflow, shutdown or callback failures can lose notifications. Reconcile current retained message state with `whatsapp::cloud::chats::list` and `whatsapp::cloud::messages::list`. Reconcile administrative state with its corresponding management API; the message archive does not store account-event history. ## Administrative and group subscriptions For template status changes, register a callback with this filter: ```json { "trigger_type": "whatsapp::cloud::events", "trigger_namespace": "default", "function_id": "automation::on-template-status", "config": { "kinds": ["webhook.received"], "fields": ["message_template_status_update"], "events": ["APPROVED", "REJECTED"] } } ``` `webhook.received` has `event_id` (a deterministic hash), `field`, optional `event`, and sanitized `data`. Its `message_id` and `chat_id` are empty. `phone_number_id` is empty for WABA-wide events without a phone identity; a nonempty phone filter excludes those events. `timestamp_ms` is Meta's entry or nested event timestamp, or zero when Meta provides none. No receipt time is substituted. Duplicate detection hashes the canonical event and supplied time. Group metadata and calling collections are split into individual events while retaining their nested `groups` or `calls` object inside `data`. Coexistence history/state/echo payloads can be subscribed to by field, but are not imported as ordinary inbox messages. This does not provision coexistence or initiate history synchronization. For a Cloud group, use: ```json { "kinds": ["message.received", "message.status"], "group_ids": ["Y2FwaV9ncm91cDoxMjM="] } ``` Group messages use `chat_id: "group:<id>"`, retain the participant as `sender_id`, and include raw `group_id`. Delivery/read receipts for an individual participant include `participant_id`; they are deduplicated per participant. They do not mark the entire group conversation as delivered/read. These subscriptions use the official Cloud Groups API, not linked-device group JIDs. Meta account eligibility and webhook field subscriptions are still required. See [Meta webhook fields](https://developers.facebook.com/documentation/business-messaging/whatsapp/webhooks/overview) and [group webhook contracts](https://developers.facebook.com/documentation/business-messaging/whatsapp/groups/webhooks).

Invocation
  • business_account_idstring/^[0-9]{0,32}$/

    Exact Meta WhatsApp Business Account ID. Omitted, empty or null means no account restriction.

  • chat_idsstring[]max 128 items

    Individual conversation identities or group:<raw Meta group ID>. Native JIDs are not supported.

  • eventsstring[]1…128 chars · /^\S(?:[\s\S]*\S)?$/ · max 128 items

    Exact value.event names, such as APPROVED. Combined with other filters using AND.

  • fieldsstring[]/^[a-z][a-z0-9_]{0,63}$/ · max 128 items

    Exact raw Meta webhook field names. For administrative notifications explicitly select kinds: [webhook.received].

  • group_idsstring[]/^[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255}$/ · max 128 items

    Raw Cloud group IDs. Applies to group messages, statuses and group metadata events.

  • kindsstring[]enum message.received, message.status, webhook.receivedmax 128 items

    Event kinds to receive. Omitted, empty or null means message.received only. Select message.status explicitly for delivery receipts.

  • message_typesstring[]/^[a-z][a-z0-9_]{0,63}$/ · max 128 items

    Exact raw Meta message types, such as text, image, interactive or contacts. Future type names are allowed. Status events have no message type and cannot match a nonempty message_types filter.

  • participant_idsstring[]max 128 items

    Group delivery/read receipt participants. Explicitly include message.status in kinds.

  • phone_number_idstring/^[0-9]{0,32}$/

    Exact Meta Phone Number ID, not the displayed telephone number. Omitted, empty or null means no phone restriction.

  • sender_idsstring[]max 128 items

    Individual sender identities (phone numbers or BSUIDs), never group IDs. Status events have no sender and cannot match a nonempty sender_ids filter.

  • statusesstring[]enum sent, delivered, read, failedmax 128 items

    Delivery states. Set kinds to include message.status; a status filter does not change the default kind. Incoming messages have no status and cannot match a nonempty statuses filter.

Return
one of (3)
Variant 1
  • chat_idstring/^(\+[1-9][0-9]{6,14}|[A-Z]{2}\.(ENT\.)?[A-Za-z0-9]{1,128}|group:[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255})$/
  • kindunknown
  • message_idunknown
  • phone_number_idunknown
  • statusunknown
Variant 2
  • chat_idstring/^(\+[1-9][0-9]{6,14}|[A-Z]{2}\.(ENT\.)?[A-Za-z0-9]{1,128}|group:[A-Za-z0-9][A-Za-z0-9_+/=-]{0,255})$/
  • kindunknown
  • message_idunknown
  • message_typeunknown
  • phone_number_idunknown
  • sender_idunknown
  • textunknown
Variant 3
  • chat_idunknown
  • kindunknown
  • message_idunknown
  • message_typeunknown
  • sender_idunknown
  • statusunknown

whatsapp::events

Trigger

Native WhatsApp session, message, receipt and group events

Invocation
  • kindsstring[]/^[A-Za-z0-9._]{1,128}$/ · max 128 items
  • session_idstring/^[A-Za-z0-9_-]{0,64}$/
Return
  • dataunknownrequired
  • kindstringrequired
  • sequenceintegerrequiredmin 0
  • session_idstringrequired
  • timestamp_msintegerrequired

Search the registry

Find workers, kits and executables, or jump to a page.