获取应用开场白和开场引导问题 API

更新时间:
复制 MD 格式

接口说明

本接口用于获取联网问答应用中配置的开场白内容和开场引导问题(包含自定义问题和热点开场问题推荐)。您可和智能对话 API 配套使用,建设完善的智能对话体验。

认证方式

服务开通 & 获取 API key

使用阿里云主账号登录 CleverSee 控制台开通联网搜索服务(目前暂不支持 RAM 用户开通服务)。创建/获取 API key:

  • 方式一:可直接通过 CleverSee 控制台-联网问答-接入文档-通过API key调用-创建API key,创建 API key(注意:创建时API key仅出现一次,请及时保存,关闭后无法再次查看)。出于安全策略,在创建 API key 时会为该主账号创建一个新的 RAM 用户,并具备 CleverSee 联网搜索服务权限。image

  • 方式二:使用主账号前往RAM 访问控制台,选择一个 RAM 用户,为该用户的权限管理中添加 AliyunCleverSeeAISearchWebSearchAccess 权限点:image并在该用户的凭证管理 Tab 下创建一个API key(注意:创建时 API key 仅出现一次,请及时保存,关闭后无法再次查看):image

请求信息

项

说明

请求方式

POST

请求地址

https://maasaisearchproxy.aliyuncs.com/api/qa/opening

请求格式

application/json

请求头

本文档介绍 API Key 鉴权方式,请在请求头中携带以下鉴权字段:

请求头

是否必填

说明

Content-Type

是

固定为 application/json

Date

是

RFC 1123 格式的 GMT 时间,例如 Wed, 30 Jul 2026 08:00:00 GMT

x-acs-apikey

是

您的 API Key

请求参数

字段

类型

是否必填

示例值/默认值

说明

appId

String

是

应用 ID

userInfo

Object

否

用户信息

userInfo.deviceId

String

否

设备 ID,可组合用户 ID作为唯一指定ID

userInfo.userId

String

否

用户 ID,可组合设备 ID作为唯一指定ID

hotQuestion

Boolean

否

默认值:false

是否开启热点问题

  • true(启用)

  • false(不启用)

count

Integer

否

示例值:10

返回热点问题的个数,最大值为20。缺失或 <=0 时默认按 10 处理,>20 时按 20 处理。

注意:实际返回个数受热搜榜结果影响,可能小于指定值

请求示例

curl -X POST 'https://maasaisearchproxy.aliyuncs.com/api/qa/opening' \
  -H 'Content-Type: application/json' \
  -H "Date: $(LC_ALL=C date -u +'%a, %d %b %Y %H:%M:%S GMT')" \
  -H 'x-acs-apikey: <YOUR_API_KEY>' \
  -d '{
    "appId": "<YOUR_APP_ID>",
    "userInfo": {
      "deviceId": "example-device-12345",
      "userId": "example-user-67890"
    },
    "hotQuestion": true,
    "count": 3
  }'

返回信息

返回参数

字段

类型

是否一定返回

说明

requestId

String

是

请求唯一标识,由系统自动生成

code

Integer

是

Proxy 业务状态码,200 表示成功

message

String

是

状态描述,成功为 successful,失败时为错误描述

data

Object

是

返回的具体业务数据

data.openingRemark

String

是

开场白,如应用未配置开场白则返回 null

data.openingQuestions

Array<string>

否

自定义的静态开场问题列表,将返回应用配置的全部开场问题(不超过5个)

data.hotQuestions

Array<string>

否

动态热点问题列表,如hotQuestion 未开启、热搜榜无结果,则可能返回空数组

成功返回示例

{
	"requestId": "1a0f40dc17847733549126077ef789",
	"code": 200,
	"message": "successful",
	"data": {
		"openingRemark": "你好吗?",
		"openingQuestions": ["你的开场问题1","你的开场问题2"],
		"hotQuestions": ["A股行情","世界杯最佳进球","杭州城郊周末游火了"]
	}
}

失败返回示例

{
  "code": 401,
  "message": "Invalid request parameters",
  "data": null
}

错误码

错误码

message

说明

建议处理方式

400

Request was denied due to user flow control

请求过于频繁,超出 QPS 阈值

降低调用频率。

401

Invalid request parameters

请求参数不合法

检查请求参数格式和长度,修改后重新发起请求。

403

NoPermission / You are not authorized to perform this action

阿里云账号权限不足

检查 RAM 用户是否已添加联网问答产品权限:AliyunCleverSeeAISearchWebSearchAccess

500

Internal server error

服务内部错误,请求处理异常

稍后重试;若持续出现,请联系技术支持并提供请求requestId、时间和参数。

503

The request has failed due to a temporary failure of the server

服务器繁忙或正在维护,当前请求无法完成。

建议您稍等片刻后刷新页面重试,若问题持续存在,请联系技术支持并提供请求requestId、时间和参数。