⚙️
Channel360
HomeSign InSign Up
  • 🏠ChannelMobile Docs
  • Quick Start
    • Channel360 API
    • AgentChat API
    • Channel360 Guide
      • Dashboard
      • Templates
        • Template Creation
        • Template Configuration
      • Groups
        • Deleting Groups
        • Managing Group Details
      • Campaign
        • Campaign Creation
        • Campaign Statistics
      • Subscribers
        • Managing Subscribers
        • Subscriber Profile
  • Whatsapp Business API
    • WABA Prerequisites
    • WhatsApp Account Health
  • Our Products
    • Products
      • AgentChat
      • SMS
      • Broadcasting
      • ChatBot
  • API Usage
    • Using the Channel360 V1.1 API
      • Notifications
      • Templates
        • Create Templates
        • Read / Get Templates
        • Update Templates
        • Delete Templates
      • Webhooks
      • Conversations
        • Send Interactive Messages
        • Send Text Message
        • Send Media Message
          • Send Video Message
          • Send Image Message
          • Send File Message
        • Get Conversation History
  • Reference
    • API Reference
      • AgentChat API
      • Channel360 V1.1 API
  • FAQs
    • General FAQs
    • Channel360 FAQs
      • Templates
      • Notification Status
    • Technical FAQs
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. API Usage
  2. Using the Channel360 V1.1 API
  3. Conversations

Send Interactive Messages

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

Arguments
Explanation

type

The type of the message e.g 'text' | 'interactive' | 'file' | 'video' | 'image'

interactive

Construct a request & the expected response using the specified API endpoint

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.

{
    "type": "interactive",
    "interactive": {
        "type": "list",
        "header": {
            "type": "text",
            "text": "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"
                        }
                    ]
                }
            ]
        }
    }
}
{
    "messages": [
        {
            "id": "669ea9e5d366ff7faaed4272",
            "received": "2024-07-22T18:50:13.927Z",
            "author": {
                "avatarUrl": "https://www.gravatar.com/avatar/00000000000000000000000000000000.png?s=200&d=mm",
                "type": "business"
            },
            "content": {
                "type": "text",
                "text": "{\"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\"}]}]}}"
            },
            "source": {
                "type": "api:conversations"
            }
        }
    ]
}

The provided YAML configuration below defines an API specification using the OpenAPI (formerly known as Swagger) format.

PreviousConversationsNextSend Text Message

Last updated 9 months ago

Was this helpful?

The body of the interactive message further documentation can be found here

Meta Documentation

Reply with Interactive Message

post

API call to reply (send) an interactive message

Path parameters
orgIdstringRequired
appUserstringRequired
Body
typestringOptionalExample: interactive
Responses
201
Successfully Replied with Interactive Message.
application/json
post
POST /info513/LK.1/1.0.0/v1.1/org/:{orgId}/whatsapp/appuser/{appUser}/reply/ HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 420

{
  "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"
              }
            ]
          ]
        }
      ]
    }
  }
}
201

Successfully Replied with Interactive Message.

{
  "messages": [
    {
      "id": "669ea9e5d366ff7faaed4272",
      "received": "2024-07-22T18:50:13.927Z",
      "author": {
        "avatarUrl": "https://www.gravatar.com/avatar/00000000000000000000000000000000.png?s=200&d=mm",
        "type": "business"
      },
      "content": {
        "type": "text",
        "text": "{\"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\"}]}]}}"
      },
      "source": {
        "type": "api:conversations"
      }
    }
  ]
}