Get conversational components

Returns the conversational components — welcome message, ice-breaker prompts, and commands — currently configured for the app's WhatsApp number.

Request parameters

Path parameters

KeyDescriptionValuesData TypeRequired/Optional
appIdIdentifier of the WhatsApp app the call acts on.6f414190-d45c-4671-bca1-fb6c3018cb13StringRequired

Sample cURL — Get conversational components.

curl --request GET \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/integration/conversational/components' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json'

Sample success response (200)

{
  "status": "success",
  "data": {
    "conversational_automation": {
      "prompts": [
        "Book a flight",
        "plan a vacation"
      ],
      "commands": [
        {
          "command_name": "tickets",
          "command_description": "Book flight tickets"
        },
        {
          "command_name": "hotel",
          "command_description": "Book hotel"
        }
      ],
      "enable_welcome_message": false,
      "id": "104229822776062"
    },
    "id": "109259195336416"
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the WhatsApp app the call acts on.

Responses

Language
Credentials
Bearer
Universal Token (UT)
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json