Send Flow Service Message | Messenger Mate | Business API Documentation

curl -X POST https://business.me-mate.net/sendservicemessages/sendmessages#postSendservicemessagesSendmessages9 \
     -H "Content-Type: application/json" \
     -d '{
  "to": "recipient-number",
  "type": "interactive",
  "api_key": "Your-production-Api-Key",
  "interactive": {
    "body": {
      "text": "write body text here"
    },
    "type": "flow",
    "action": {
      "name": "flow",
      "parameters": {
        "flow_id": "Unique ID of the Flow provided by WhatsApp",
        "flow_cta": "flow Button display name",
        "flow_token": "token to identify the corresponding Flow (e.g. 7f451b5d-38e2-40c7-b70d-6984ffc19fc4)",
        "flow_action": "navigate",
        "flow_action_payload": {
          "screen": "screenA"
        },
        "flow_message_version": "3"
      }
    },
    "footer": {
      "text": "write footer text here"
    },
    "header": {
      "text": "write header text here",
      "type": "text"
    }
  },
  "recipient_type": "individual",
  "messaging_product": "whatsapp"
}'

{
  "contacts": [
    {
      "input": "recipient's-number",
      "wa_id": "recipient's-number"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgMOTE3MzE5OTUwMzUwFQIAERgSREMyQkZFQUVEMzdGRUY2MEEzAA=="
    }
  ],
  "messaging_product": "whatsapp"
}

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).

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 is`required 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?](#requirements) ### 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).

Request

This endpoint expects an object.

tostringRequired

typestringRequired

api_keystringRequired

interactiveobjectRequired

recipient_typestringRequired

messaging_productstringRequired

Response

contactslist of objects

messageslist of objects

messaging_productstring

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).