跳到主要内容

应用管理

创建应用​

在「创建应用」弹窗中填写应用名称、应用描述,并选择应用类型。创建成功后立即保存凭证 Secret,页面离开后不会再次显示完整 Secret。

应用类型决定可用的能力域,创建后不可更改:

应用类型appType 取值可用能力
通用应用GENERAL客服 V1 能力(默认值)
客服应用CUSTOMER_SERVICE客服工作台场景
应用机器人BOT机器人 V2 能力、机器人安装关系
小程序商城MINIAPP小程序 V2 运行时能力

获取接入凭证与租户 ID​

调用开放 API 需要 appId、credentialId、appSecret、tenantId 四个值,它们都可以在控制台取得:

值在哪里获取
appId应用详情「应用概览」页:应用名称下方直接显示(形如 app_...);应用管理列表的应用名称下方也会显示
credentialId创建应用后弹出的「保存应用凭证」窗口中的 Credential ID 字段,取值以 cred_ 开头;错过则只能通过「轮换凭证」重新生成
appSecret同上,仅在创建或轮换时展示一次,窗口关闭后无法再次查看
tenantId应用管理列表页顶部「当前企业」一行中,企业名后面那个数字

应用详情「应用概览」页,应用名称下设红框的即 appId

应用管理列表,每个应用名称下设红框的即 appId

创建应用时页面会提示「应用创建后将生成一组只展示一次的初始凭证」,创建完成后弹出「保存应用凭证」窗口,Credential ID 与 Secret 只在此时完整可见:

创建应用弹窗,顶部提示将生成一组只展示一次的初始凭证

「保存应用凭证」窗口,两个字段分别标注为 Credential ID 与 Secret

  • 窗口中的 Credential ID 就是请求签名所需的 credentialId,取值以 cred_ 开头(如 cred_8322360368d94d37a234e955);Secret 就是 appSecret;
  • 需要点击「我已安全保存」确认,关闭窗口后无法再次查看 Secret;
  • 把 Secret 写入服务端密钥管理系统,不要写入前端代码、日志、截图或版本库。

若错过了这次展示,或需要更换凭证,进入应用详情的「凭证」页点击「轮换凭证」。该页只有一张「生产凭证」卡片和一个「轮换凭证」按钮,页面上不会展示当前的 credentialId 或 appSecret:

应用详情「凭证」页,含生产凭证卡片与红框标出的「轮换凭证」按钮

轮换后弹出「新凭证已生成」窗口,两个输入框都没有字段名,按取值区分:

窗口中的位置对应值识别方式
上面那个credentialId以 cred_ 开头,如 cred_8c7fd3fd4c48e458bb39eec39
下面那个appSecret不以 cred_ 开头的随机字符串

轮换后弹出的「新凭证已生成」窗口,上框为 cred_ 开头的 credentialId、下框为 appSecret

tenantId 是客服开通等控制台接口必需的租户 ID,在应用管理列表页顶部与当前企业名一同显示:

应用管理列表页顶部,当前企业名后的数字即 tenantId

配置应用​

依次完成:

  1. 编辑基本资料;
  2. 申请最小 Scope;
  3. 配置事件订阅并验证回调地址;
  4. 配置机器人资料或小程序版本(如适用);
  5. 提交审核。

凭证轮换​

凭证页只有「生产凭证」卡片与「轮换凭证」按钮,卡片上说明:出于安全原因,已有 Secret 不可查看;轮换后旧凭证保留 24 小时宽限期。 该页没有单独的撤销凭证操作,因此轮换前应先让服务端支持新旧凭证并存。

点击「轮换凭证」会生成新的 credentialId 与 appSecret,仅在「新凭证已生成」弹窗中展示一次(该弹窗的两个输入框没有字段名,cred_ 开头的是 credentialId,另一个是 appSecret),点击「我已保存」关闭。建议先在服务端部署兼容新凭证的代码,再切换流量,并在宽限期内完成切换。Secret 不应通过工单、聊天或浏览器 LocalStorage 传递。

审核状态​

DRAFT 可以继续编辑,SUBMITTED 等待审核,ACTIVE 才能调用开放 API,REJECTED 需要根据原因修改后重新提交,SUSPENDED 需要处理风险或管理员要求后恢复。