Send Interactive Messages

Interactive list messages allow you to present users with a list of options to choose from.

We partially support interactive messages. These messages will appear in the conversation history as encoded JSON within a text-type message, preserving their original structure and content.

Reply with Interactive Message

POST /v.1.1/org/:orgId/whatsapp/appuser/:appuser/reply

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
type	string	The type of the message e.g 'text' | 'interactive' | 'file' | 'video' | 'image'
interactive	object	The body of the interactive message further documentation can be found here Meta Documentation
flow_token	string	Generated by the business to serve as an identifier. It will be sent as part of each request. You should always verify that token on your server to block any other unexpected requests. Required for Flows with endpoint. The token will come back in the webhook event.

Interactive List Message

curl -X POST "https://www.channel360.co.za/v1.1/org/{orgId}/whatsapp/appuser/{appUser}/reply" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: */*" \
  -d '{
    "type": "interactive",
    "interactive": {
      "type": "list",
      "header": {
        "type": "text",
        "text": "CSAT Survey"
      },
      "body": {
        "text": "How likely are you to recommend whatsapp to a friend?"
      },
      "footer": {
        "text": "Please make your selection"
      },
      "action": {
        "button": "Answers",
        "sections": [
          {
            "title": "Your score:",
            "rows": [
              { "id": "001", "title": "1" },
              { "id": "002", "title": "2" },
              { "id": "003", "title": "3" },
              { "id": "004", "title": "4" },
              { "id": "005", "title": "5" }
            ]
          }
        ]
      }
    }
  }'

Interactive Flow Message

curl -X POST "https://www.channel360.co.za/v1.1/org/{orgId}/whatsapp/appuser/{appUser}/reply" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: */*" \
  -d '{
    "type": "interactive",
    "interactive": {
      "type": "flow",
      "header": {
        "type": "text",
        "text": "Hello!"
      },
      "body": {
        "text": "How likely are you to recommend whatsapp to a friend?"
      },
      "footer": {
        "text": "Powered by Channel Mobile"
      },
      "action": {
        "name": "flow",
        "parameters": {
          "flow_message_version": "3",
          "flow_token": "123456",
          "flow_id": "2393058303453469",
          "flow_cta": "Start Flow"
        }
      }
    }
  }'