文档

CreateScript - 创建话术

更新时间:

创建话术。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

实例 ID

c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4
ScriptNamestring

话术名称

课程满意度回访
ScriptDescriptionstring

话术描述

课程回复话术
Industrystring

所属行业

教育
Scenestring

所属场景

回访
ChatbotIdstring

当 Instance 的 NluServiceType 为 Authorized 或 Provided 时,需要通过此字段指定话术需要绑定的对话机器人实例 ID

chatbot-cn-IfaUfqaUnb
AsrConfigstring

asr 配置,参数定义

  • appKey:阿里云账号 appKey。
  • maxEndSilence:语音端点检测时长。
  • silenceTimeout:静默超时,单位秒,用户静默 N 秒后超时。
{\"appKey\":\"kknxKIhTTUcpCzYX\",\"maxEndSilence\":\"400\",\"silenceTimeout\":\"5\"}
TtsConfigstring

tts 配置,参数定义

  • voice:发音人。
  • volume:音量,取值范围:0~100。默认值:50。
  • speechRate:语速,取值范围:-500~500,默认值:0。
  • pitchRate:语调,取值范围:-500~500,默认值:0。
{\"voice\":\"aixia\",\"volume\":\"50\",\"speechRate\":\"-150\",\"pitchRate\":\"0\"}
ScriptContentarray

通知类实例,传入话术列表。 已废弃。

string

通知类实例,传入话术列表。 已废弃。

您好,您昨晚在李佳琦直播间下单的娜薇诗椰子水二代精华2支装还未付款,超时未支付会自动关闭订单,活动错过不再有奥。
ScriptWaveformarray

通知类实例,传入话术声音列表。 已废弃。

string

通知类实例,传入话术声音列表。 已废弃。

[]
MiniPlaybackEnableboolean

承接语配置开关

true
NewBargeInEnableboolean

优雅打断配置开关

true
LongWaitEnableboolean

智能断句配置开关

true
EmotionEnableboolean

情绪识别配置开关

true
AgentKeystring

机器人业务空间访问 Key

9137ab9c27044921860030adf8590ec4_p_outbound_public
AgentLlmboolean

机器人业务空间是否大模型业务空间

false
AgentIdlong

机器人业务空间 ID

1198938

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

http 状态码

200
RequestIdstring

请求 id

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Successboolean

是否成功

true
Codestring

响应码

OK
Messagestring

接口提示信息

Success
Scriptobject

话术信息

Statusstring

任务状态。取值范围:

  • DRAFTED:草稿态。
  • INITIALIZE_IN_PROGRESS:正在初始化。
  • PUBLISHED:已发布。
  • PUBLISH_IN_PROGRESS:正在发布。
  • ROLLBACK_IN_PROGRESS:正在回滚。
  • EXAMINE_IN_PROGRESS:待审核。
  • PUBLISHED_AND_EXAMINE_IN_PROGRESS:已发布待审核状态。
  • PUBLISH_FAILED:发布失败。
  • ROLLBACK_FAILED:回滚失败。
  • IMPORT_IN_PROGRESS:正在导入。
  • IMPORT_FAILED:导入失败。
DRAFTED
UpdateTimelong

话术更新时间(单位:毫秒)

1578474045152
Industrystring

所属行业

教育
ScriptDescriptionstring

话术描述

课程满意度回访
IsDraftedboolean

是否是草稿

true
DebugStatusstring

话术调试状态

DRAFTED
ScriptIdstring

话术 id

8c58d3e0-bf27-4685-a5a5-65872ec5abc4
IsDebugDraftedboolean

是否是调试的草稿

true
ScriptNamestring

话术名称

课程满意度回访
Scenestring

所属场景

回访

示例

正常返回示例

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": "",
    "NluAccessType": ""
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidScriptName.DuplicatedThe specified ScriptName already exists.话术名称已经存在。请您更换一个名字。
404NotExist.InstanceThe specified Instance does not exist.指定的实例不存在。
500InternalErrorAn error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.内部错误。建议重试,如果多次重试报错请提交工单。

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

变更历史

变更时间变更内容概要操作
2024-08-06OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-04-25OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-01-09OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2022-06-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情