返回一个话术的信息
调试
您可以在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 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | OK |
接口状态码 |
HttpStatusCode | Integer | 200 |
http 状态码 |
Message | String | Success |
接口提示消息 |
RequestId | String | 254EB995-DEDF-48A4-9101-9CA5B72FFBCC |
请求id |
Script | Struct |
话术 |
|
DebugStatus | String | DRAFTED |
调试话术的状态 |
Industry | String | 金融 |
行业 |
IsDebugDrafted | Boolean | true |
是否是调试话术的草稿状态 |
IsDrafted | Boolean | true |
是否是草稿状态 |
Scene | String | 回访 |
场景 |
ScriptDescription | String | 回访话术 |
话术描述 |
ScriptId | String | 810b5872-57f0-4b27-80ab-7b3f4d8a6374 |
话术id |
ScriptName | String | 回访话术 |
话术名字 |
Status | String | DRAFTED |
话术状态 |
UpdateTime | Long | 1578881227000 |
更新时间 |
Success | Boolean | true |
是否成功 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeScript
&InstanceId=38d2e8ed-04e9-4dac-83b5-a8e57642ef13
&ScriptId=bee7e5b1-5d9a-4389-aa7e-bbbee5353a16
&<公共请求参数>
正常返回示例
XML
格式
<Code>OK</Code>
<HttpStatusCode>200</HttpStatusCode>
<RequestId>f765d3ee-ec03-4765-b235-6877501d99d1</RequestId>
<Script>
<DebugStatus>DRAFTED</DebugStatus>
<Industry>教育</Industry>
<IsDebugDrafted>true</IsDebugDrafted>
<IsDrafted>true</IsDrafted>
<ScriptName>课程满意度回访</ScriptName>
<Scene>回访</Scene>
<ScriptId>8c58d3e0-bf27-4685-a5a5-65872ec5abc4</ScriptId>
<Status>DRAFTED</Status>
<UpdateTime>1578474045152</UpdateTime>
</Script>
<Success>true</Success>
JSON
格式
{
"Code": "OK",
"HttpStatusCode": 200,
"RequestId": "f765d3ee-ec03-4765-b235-6877501d99d1",
"Script": {
"DebugStatus": "DRAFTED",
"Industry": "教育",
"IsDebugDrafted": true,
"IsDrafted": true,
"ScriptName": "课程满意度回访",
"Scene": "回访",
"ScriptId": "8c58d3e0-bf27-4685-a5a5-65872ec5abc4",
"Status": "DRAFTED",
"UpdateTime": 1578474045152
},
"Success": true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 指定的实例不存在。 |
404 | NotExist.Script | The specified Script does not exist. | 指定的话术不存在。 |
访问错误中心查看更多错误码。