返回一个话术的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DescribeScript | 系统规定参数。取值:DescribeScript。 |
InstanceId | String | 是 | 38d2e8ed-04e9-4dac-83b5-a8e57642ef13 | 实例ID |
ScriptId | String | 是 | bee7e5b1-5d9a-4389-aa7e-bbbee5353a16 | 话术ID |
返回数据
名称 |
类型 |
示例值 |
描述 |
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 | 1578881227000 | 更新时间 |
ChatbotId | String | chatbot-cn-EJfqqa*** | 对话机器人ID |
ScriptId | String | 810b5872-57f0-4b27-80ab-7b3f4d8a6374 | 话术ID |
IsDebugDrafted | Boolean | true | 调试版本是否为草稿态 |
Industry | String | 金融 | 行业 |
ScriptDescription | String | 催收话术 | 话术描述 |
MiniPlaybackEnable | Boolean | true | 语气承接配置开关 |
IsDrafted | Boolean | true | 是否是草稿状态 |
TtsConfig | String | {\"voice\":\"xiaobei\",\"volume\":\"50\",\"speechRate\":\"-150\",\"pitchRate\":\"0\"} | 话术的TTS配置 |
DebugStatus | String | DRAFTED | 调试话术的状态 |
AsrConfig | String | {\"AppKey\":\"3GHttnsvir1FeWWb\"} | ASR配置 |
Scene | String | 催收 | 场景 |
ScriptName | String | 催收话术 | 话术名字 |
NewBargeInEnable | Boolean | true | 优雅打断配置开关 |
LongWaitEnable | Boolean | true | 智能断句配置开关 |
EmotionEnable | Boolean | true | 情绪识别配置开关 |
AgentId | Long | 1218333 | 机器人业务空间访问Key |
AgentKey | String | 14791f5f226b4878b3d9b676a0291234 | 机器人业务空间访问Key |
AgentLlm | Boolean | true | 机器人业务空间是否大模型业务空间 |
NlsConfig | String | none | 已作废 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeScript
&InstanceId=38d2e8ed-04e9-4dac-83b5-a8e57642ef13
&ScriptId=bee7e5b1-5d9a-4389-aa7e-bbbee5353a16
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeScriptResponse>
<HttpStatusCode>200</HttpStatusCode>
<RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
<Success>true</Success>
<Code>OK</Code>
<Message>Success</Message>
<Script>
<Status>DRAFTED</Status>
<UpdateTime>1578881227000</UpdateTime>
<ChatbotId>chatbot-cn-EJfqqa***</ChatbotId>
<ScriptId>810b5872-57f0-4b27-80ab-7b3f4d8a6374</ScriptId>
<IsDebugDrafted>true</IsDebugDrafted>
<Industry>金融</Industry>
<ScriptDescription>催收话术</ScriptDescription>
<MiniPlaybackEnable>true</MiniPlaybackEnable>
<IsDrafted>true</IsDrafted>
<TtsConfig>{\"voice\":\"xiaobei\",\"volume\":\"50\",\"speechRate\":\"-150\",\"pitchRate\":\"0\"}</TtsConfig>
<DebugStatus>DRAFTED</DebugStatus>
<AsrConfig>{\"AppKey\":\"3GHttnsvir1FeWWb\"}</AsrConfig>
<Scene>催收</Scene>
<ScriptName>催收话术</ScriptName>
<NewBargeInEnable>true</NewBargeInEnable>
<LongWaitEnable>true</LongWaitEnable>
<EmotionEnable>true</EmotionEnable>
<AgentId>1218333</AgentId>
<AgentKey>14791f5f226b4878b3d9b676a0291234</AgentKey>
<AgentLlm>true</AgentLlm>
</Script>
<NlsConfig>none</NlsConfig>
</DescribeScriptResponse>
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" : 1578881227000,
"ChatbotId" : "chatbot-cn-EJfqqa***",
"ScriptId" : "810b5872-57f0-4b27-80ab-7b3f4d8a6374",
"IsDebugDrafted" : true,
"Industry" : "金融",
"ScriptDescription" : "催收话术",
"MiniPlaybackEnable" : true,
"IsDrafted" : true,
"TtsConfig" : "{\\\"voice\\\":\\\"xiaobei\\\",\\\"volume\\\":\\\"50\\\",\\\"speechRate\\\":\\\"-150\\\",\\\"pitchRate\\\":\\\"0\\\"}",
"DebugStatus" : "DRAFTED",
"AsrConfig" : "{\\\"AppKey\\\":\\\"3GHttnsvir1FeWWb\\\"}",
"Scene" : "催收",
"ScriptName" : "催收话术",
"NewBargeInEnable" : true,
"LongWaitEnable" : true,
"EmotionEnable" : true,
"AgentId" : 1218333,
"AgentKey" : "14791f5f226b4878b3d9b676a0291234",
"AgentLlm" : true
},
"NlsConfig" : "none"
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
404 | NotExist.Instance | The specified Instance does not exist. | 指定的实例不存在。 |
404 | NotExist.Script | The specified Script does not exist. | 指定的话术不存在。 |
500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. | 内部错误。建议重试,如果多次重试报错请提交工单。 |
访问错误中心查看更多错误码。
文档内容是否对您有帮助?