创建话术。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | CreateScript | 系统规定参数。取值:CreateScript。 |
InstanceId | String | 是 | c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4 | 实例ID |
ScriptName | String | 是 | 课程满意度回访 | 话术名称 |
ScriptDescription | String | 否 | 课程回复话术 | 话术描述 |
Industry | String | 是 | 教育 | 所属行业 |
Scene | String | 是 | 回访 | 所属场景 |
ChatbotId | String | 否 | chatbot-cn-IfaUfqaUnb | 当Instance的NluServiceType为Authorized或Provided时,需要通过此字段指定话术需要绑定的对话机器人实例ID |
AsrConfig | String | 否 | {\"appKey\":\"kknxKIhTTUcpCzYX\",\"maxEndSilence\":\"400\",\"silenceTimeout\":\"5\"} | ASR配置,参数定义
|
TtsConfig | String | 否 | {\"voice\":\"aixia\",\"volume\":\"50\",\"speechRate\":\"-150\",\"pitchRate\":\"0\"} | TTS配置,参数定义
|
ScriptContent.N | String | 否 | 您好,您昨晚在李佳琦直播间下单的娜薇诗椰子水二代精华2支装还未付款,超时未支付会自动关闭订单,活动错过不再有奥。 | 通知类实例,传入话术列表。 已废弃。 |
ScriptWaveform.N | String | 否 | [] | 通知类实例,传入话术声音列表。 已废弃。 |
MiniPlaybackEnable | Boolean | 否 | true | 承接语配置开关 |
NewBargeInEnable | Boolean | 否 | true | 优雅打断配置开关 |
LongWaitEnable | Boolean | 否 | true | 智能断句配置开关 |
EmotionEnable | Boolean | 否 | true | 情绪识别配置开关 |
AgentKey | String | 否 | 9137ab9c27044921860030adf8590ec4_p_outbound_public | 机器人业务空间访问Key |
AgentLlm | Boolean | 否 | false | 机器人业务空间是否大模型业务空间 |
AgentId | Long | 否 | 1198938 | 机器人业务空间ID |
NluEngine | String | 否 | Prompts | Nlu引擎(仅大模型场景适用)枚举:Prompts-大模型场景, 非大模型场景则为空。 |
NluAccessType | String | 否 | Managed | Nlu访问方式(仅大模型场景适用)枚举:Managed-使用阿里公共账号访问,非大模型场景则为空。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
HttpStatusCode | Integer | 200 | HTTP状态码 |
RequestId | String | 254EB995-DEDF-48A4-9101-9CA5B72FFBCC | 请求ID |
Success | Boolean | true | 是否成功 |
Code | String | OK | 响应码 |
Message | String | Success | 接口提示信息 |
Script | Object | 话术信息 |
|
Status | String | DRAFTED | 任务状态。取值范围:
|
UpdateTime | Long | 1578474045152 | 话术更新时间(单位:毫秒) |
Industry | String | 教育 | 所属行业 |
ScriptDescription | String | 课程满意度回访 | 话术描述 |
IsDrafted | Boolean | true | 是否是草稿 |
DebugStatus | String | DRAFTED | 话术调试状态 |
ScriptId | String | 8c58d3e0-bf27-4685-a5a5-65872ec5abc4 | 话术ID |
IsDebugDrafted | Boolean | true | 是否是调试的草稿 |
ScriptName | String | 课程满意度回访 | 话术名称 |
Scene | String | 回访 | 所属场景 |
NluEngine | String | Prompts | Nlu引擎(仅大模型场景适用)枚举:Prompts-大模型场景, 非大模型场景则为空。 |
NluAccessType | String | Managed | Nlu访问方式(仅大模型场景适用)枚举:Managed-使用阿里公共账号访问,非大模型场景则为空。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateScript
&InstanceId=c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4
&ScriptName=课程满意度回访
&ScriptDescription=课程回复话术
&Industry=教育
&Scene=回访
&ChatbotId=chatbot-cn-IfaUfqaUnb
&AsrConfig={\"appKey\":\"kknxKIhTTUcpCzYX\",\"maxEndSilence\":\"400\",\"silenceTimeout\":\"5\"}
&TtsConfig={\"voice\":\"aixia\",\"volume\":\"50\",\"speechRate\":\"-150\",\"pitchRate\":\"0\"}
&ScriptContent=["您好,您昨晚在李佳琦直播间下单的娜薇诗椰子水二代精华2支装还未付款,超时未支付会自动关闭订单,活动错过不再有奥。"]
&ScriptWaveform=["[]"]
&MiniPlaybackEnable=true
&NewBargeInEnable=true
&LongWaitEnable=true
&EmotionEnable=true
&AgentKey=9137ab9c27044921860030adf8590ec4_p_outbound_public
&AgentLlm=false
&AgentId=1198938
&NluEngine=Prompts
&NluAccessType=Managed
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateScriptResponse>
<HttpStatusCode>200</HttpStatusCode>
<RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
<Success>true</Success>
<Code>OK</Code>
<Message>Success</Message>
<Script>
<Status>DRAFTED</Status>
<UpdateTime>1578474045152</UpdateTime>
<Industry>教育</Industry>
<ScriptDescription>课程满意度回访</ScriptDescription>
<IsDrafted>true</IsDrafted>
<DebugStatus>DRAFTED</DebugStatus>
<ScriptId>8c58d3e0-bf27-4685-a5a5-65872ec5abc4</ScriptId>
<IsDebugDrafted>true</IsDebugDrafted>
<ScriptName>课程满意度回访</ScriptName>
<Scene>回访</Scene>
<NluEngine>Prompts</NluEngine>
<NluAccessType>Managed</NluAccessType>
</Script>
</CreateScriptResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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"
}
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
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. | 内部错误。建议重试,如果多次重试报错请提交工单。 |
访问错误中心查看更多错误码。
文档内容是否对您有帮助?