CreateDialog - 创建外呼会话

创建外呼会话。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dianjin:CreateDialogcreate
*全部资源
*

请求语法

POST /{workspaceId}/api/virtualHuman/dialog/create HTTP/1.1

请求参数

名称类型必填描述示例值
workspaceIdstring

业务空间 id

llm-xxxxx
bodyobject

请求体。

playCodestring

剧本编码

live_broadcast_qa
channelstring

渠道

taobao
metaDataobject

其他信息

null
qaLibraryListarray

QA 问答库 ID 列表

qaLibraryListstring

QA 问答库 ID

d86a4b9cd3
requestIdstring

请求 ID

ebf83826-dc1c-46f8-9759-0fb6da4c8xxx
enableLibraryboolean

是否开启意图库

false
selfDirectedboolean

是否开启自主问答

false

返回参数

名称类型描述示例值
object

ResultCode

successboolean

是否成功

true
dataTypestring

数据类型

null
timestring

时间戳

2024-01-01 00:00:00
errCodestring

错误码

0
messagestring

错误信息

ok
dataobject

响应数据

sessionIdstring

会话 ID

1728545917713234
openingRemarksstring

开场白

你好,我是XX客服人员。
requestIdstring

请求 id

003D019A-1BB3-53EC-A0D2-CE76DA5D73B1
costlong

耗时

null

示例

正常返回示例

JSON格式

{
  "success": true,
  "dataType": "null",
  "time": "2024-01-01 00:00:00",
  "errCode": "0",
  "message": "ok",
  "data": {
    "sessionId": "1728545917713234",
    "openingRemarks": "你好,我是XX客服人员。"
  },
  "requestId": "003D019A-1BB3-53EC-A0D2-CE76DA5D73B1",
  "cost": 0
}

错误码

访问错误中心查看更多错误码。