v1

latestOpenAPI 3.0.32026-07-268345159.5 KB

Conversational Component

Set Conversational Component

post/partner/app/{appId}/conversational/component

Path parameters

appIdstring required

Unique identifier of the app.

Headers

tokenstring required

Your app token, please refer Get access token api to get the token from partner documentation.

Request body

object required

Example request

{
  "enable_welcome_message": true,
  "commands": [
    {
      "command_name": "tickets",
      "command_description": "Book flight tickets"
    },
    {
      "command_name": "hotel",
      "command_description": "Book hotel"
    }
  ],
  "prompts": [
    "Book a flight",
    "plan a vacation"
  ]
}

Response

Successful response

statusstring

successboolean

Example response

{
  "status": "success"
}