Send Flow Service Message

This endpoint allows you to send service messages to individual recipients via the WhatsApp messaging product.

Request

• Method: POST

• URL: https://business.me-mate.net/sendservicemessages/sendmessages

• Headers:

  • Content-Type: application/json

• Body:

• to (string): The recipient’s number.

• type (string): in this case, “interactive”.

• interactive (object): The interactive message content.

  • body (object): The body of the interactive message.

    • text (string): The text content of the message body.

  • type (string): The type of interactive message, in this case it must be, “flow”.

  • action (object): The action to be performed with the interactive message.

    • name (string): The name of the action, in this case, “flow”.

    • parameters (object): Parameters for the action.

      • flow_id (string): Unique ID of the Flow provided by WhatsApp.

      • flow_cta (string): The display name for the flow button.

      • flow_token (string): Token to identify the corresponding flow. Flow token that is generated by the business to serve as an identifier.

      • flow_action (string): The action to be performed, like: navigate or data_exchange.(Default value: navigate).

      • flow_action_payload (object): Payload for the action. screen name and data which is optional. flow_action_payload isrequired if flow_action is navigate.

      • flow_message_version (string): The version of the flow message it must be 3.

  • footer (object): The footer of the interactive message.

    • text (string, optional): The text content of the message footer.

  • header (object): The header of the interactive message.

    • text (string): The text content of the message header.

    • type (string): The type of header, in this case, “text”.

Note : You can use Different Types of message Header (like: Image, video and Document) same as Reply Button

• recipient_type (string): The type of recipient, in this case, “individual”.

• messaging_product (string): The messaging product, in this case, “whatsapp”.

• api_key (string): Your production API key. > How to get Your API key?

Response

The response for this request is a JSON schema with the following structure:

• messaging_product (string): The messaging product used.

• contacts (array): An array of contacts with the following details:

  • input (string): The input details.

  • wa_id (string): The WhatsApp ID.

• messages (array): An array of messages with the following details:

  • id (string): The ID of the message (by Meta).