创建话术。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 ID | c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4 |
ScriptName | string | 是 | 话术名称 | 课程满意度回访 |
ScriptDescription | string | 否 | 话术描述 | 课程回复话术 |
Industry | string | 是 | 所属行业 | 教育 |
Scene | string | 是 | 所属场景 | 回访 |
ChatbotId | string | 否 | 当 Instance 的 NluServiceType 为 Authorized 或 Provided 时,需要通过此字段指定话术需要绑定的对话机器人实例 ID | chatbot-cn-IfaUfqaUnb |
AsrConfig | string | 否 | ASR 配置,参数定义
| {\"appKey\":\"kknxKIhTTUcpCzYX\",\"maxEndSilence\":\"400\",\"silenceTimeout\":\"5\"} |
TtsConfig | string | 否 | TTS 配置,参数定义
| {\"voice\":\"aixia\",\"volume\":\"50\",\"speechRate\":\"-150\",\"pitchRate\":\"0\"} |
ScriptContent | array | 否 | 通知类实例,传入话术列表。 已废弃。 | |
string | 否 | 通知类实例,传入话术列表。 已废弃。 | 您好,您昨晚在李佳琦直播间下单的娜薇诗椰子水二代精华2支装还未付款,超时未支付会自动关闭订单,活动错过不再有奥。 | |
ScriptWaveform | array | 否 | 通知类实例,传入话术声音列表。 已废弃。 | |
string | 否 | 通知类实例,传入话术声音列表。 已废弃。 | [] | |
MiniPlaybackEnable | boolean | 否 | 承接语配置开关 | true |
NewBargeInEnable | boolean | 否 | 优雅打断配置开关 | true |
LongWaitEnable | boolean | 否 | 智能断句配置开关 | true |
EmotionEnable | boolean | 否 | 情绪识别配置开关 | true |
AgentKey | string | 否 | 机器人业务空间访问 Key | 9137ab9c27044921860030adf8590ec4_p_outbound_public |
AgentLlm | boolean | 否 | 机器人业务空间是否大模型业务空间 | false |
AgentId | long | 否 | 机器人业务空间 ID | 1198938 |
NluEngine | string | 否 | Nlu 引擎(仅大模型场景适用)枚举:Prompts-大模型场景, 非大模型场景则为空。 | Prompts |
NluAccessType | string | 否 | Nlu 访问方式(仅大模型场景适用)枚举:Managed-使用阿里公共账号访问,非大模型场景则为空。 | Managed |
返回参数
示例
正常返回示例
JSON
格式
{
"HttpStatusCode": 200,
"RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
"Success": true,
"Code": "OK",
"Message": "Success",
"Script": {
"Status": "DRAFTED",
"UpdateTime": 1578474045152,
"Industry": "教育",
"ScriptDescription": "课程满意度回访",
"IsDrafted": true,
"DebugStatus": "DRAFTED",
"ScriptId": "8c58d3e0-bf27-4685-a5a5-65872ec5abc4",
"IsDebugDrafted": true,
"ScriptName": "课程满意度回访",
"Scene": "回访",
"NluEngine": "Prompts",
"NluAccessType": "Managed"
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidScriptName.Duplicated | The specified ScriptName already exists. | 话术名称已经存在。请您更换一个名字。 |
404 | NotExist.Instance | The specified Instance does not exist. | 指定的实例不存在。 |
500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. | 内部错误。建议重试,如果多次重试报错请提交工单。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-08-06 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-04-25 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-01-09 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2022-06-21 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |