创建场景。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
outboundbot:CreateScript |
create |
*Instance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| 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 配置,参数定义
说明
当 engine 选择 ali,nlsServiceType 为 Authorized 时,使用的是自定义服务,服务方为 ali,当 engine 为 ali,nlsServiceType 为 Managed 时,使用默认服务,当 engine 为 xunfei,nlsServiceType 为 Authorized 时,使用的服务方为 xunfei,需要填入 xunfei 配置{"uuid":"ed2xxxxxxxxx","globalMaxEndSilence":700,"globalMaxEndSilenceEnable":true}
|
{ "appKey": "oQDVNlE6fZ5mg46X", "engine": "ali", "engineXunfei": "", "globalMaxEndSilence": 700, "globalMaxEndSilenceEnable": true, "maxEndSilence": "500", "nlsServiceType": "Managed", "silenceTimeout": "5000", "speechNoiseThreshold": "0" } |
| TtsConfig |
string |
否 |
TTS 配置,参数定义
说明
1.当 engine 选择 ali,nlsServiceType 为 Authorized 时,使用的是自定义服务;2.当服务方为 ali,当 engine 为 ali,nlsServiceType 为 Managed 时,使用默认服务;3.当 engine 为 xunfei(小模型场景适用),nlsServiceType 为 Authorized 时,使用的服务方为 xunfei,需要填入 engineXunfei 配置{"pitchRate":50,"speechRate":50,"voice":"aisjiuxu","volume":50};4.当 engine 为 vloc,nlsServiceType 为 Authorized 时表示适用的为 doubao。 |
{ "appKey": "oQDVNlE6fZ5mg46X", "engine": "ali", "engineXunfei": "", "globalInterruptible": true, "nlsServiceType": "Managed", "pitchRate": "0", "speechRate": "0", "voice": "zhiyuan", "volume": "50" } |
| 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 |
integer |
否 |
机器人业务空间 ID |
1198938 |
| NluEngine |
string |
否 |
Nlu 引擎(仅大模型场景适用)非大模型场景则为空。
枚举值:
|
Prompts |
| NluAccessType |
string |
否 |
Nlu 访问方式(仅大模型场景适用)枚举:Managed-使用阿里公共账号访问,非大模型场景则为空。 |
Managed |
| ScriptNluProfileJsonString |
string |
否 |
说明
当 nluEngine 为 SSE_FUNUNCTION 时必须需传入对应配置 函数计算服务模式配置
|
{"fcRegion":"cn-shanghai","fcFunction":"waihu_test","fcHttpTriggerUrl":"https://waihu-test.xxxxxxxxxxx.cn-shanghai-vpc.fcapp.run"} |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| HttpStatusCode |
integer |
HTTP 状态码 |
200 |
| RequestId |
string |
请求 ID |
254EB995-DEDF-48A4-9101-9CA5B72FFBCC |
| Success |
boolean |
是否成功 |
true |
| Code |
string |
响应码 |
OK |
| Message |
string |
接口提示信息 |
Success |
| Script |
object |
话术信息 |
|
| Status |
string |
任务状态。取值范围:
|
DRAFTED |
| UpdateTime |
integer |
话术更新时间(单位:毫秒) |
1578474045152 |
| Industry |
string |
所属行业 |
教育 |
| ScriptDescription |
string |
话术描述 |
课程满意度回访 |
| IsDrafted |
boolean |
是否是草稿 |
true |
| DebugStatus |
string |
话术调试状态 |
DRAFTED |
| ScriptId |
string |
话术 ID |
8c58d3e0-bf27-4685-a5a5-65872ec5abc4 |
| IsDebugDrafted |
boolean |
是否是调试的草稿 |
true |
| ScriptName |
string |
话术名称 |
课程满意度回访 |
| Scene |
string |
所属场景 |
回访 |
| 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. | 话术名称已经存在。请您更换一个名字。 |
| 500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. | 内部错误。建议重试,如果多次重试报错请提交工单。 |
| 404 | NotExist.Instance | The specified Instance does not exist. | 指定的实例不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。