使用GetSummaryTemplate获取会话小结模板内容。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| TemplateId |
string |
是 |
模板 ID。 |
43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492 |
| InstanceId |
string |
是 |
实例 ID。 |
ccc-test |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
GetSummaryTemplateResponse |
||
| Data |
object |
数据。 |
|
| InstanceId |
string |
实例 ID。 |
ccc-test |
| TemplateId |
string |
模板 ID。 |
43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492 |
| CategoryId |
string |
小结类目 ID。 |
8939-4223-86d0-6bd187905cc8 |
| Name |
string |
模板名称。 |
测试模板 |
| State |
string |
状态码。
|
Enabled |
| Editor |
string |
模板编辑人。 |
editor-xxx@ccc-test |
| PropertyList |
array<object> |
模板字段列表。 |
|
|
object |
字段定义。 |
||
| DisplayName |
string |
显示名称。 |
DisplayName-A |
| Description |
string |
字段描述。 |
Description-xxxx |
| Name |
string |
字段名称。 |
Name-A |
| DataType |
string |
数据类型 。 |
string |
| Pattern |
string |
正则表达式校验规则。 |
^ |
| PatternErrorMessage |
string |
正则表达式校验错误提示信息。 |
不是有效的email地址 |
| MinLength |
integer |
最小长度。 |
1 |
| MaxLength |
integer |
最大长度。 |
30 |
| Minimum |
number |
数字最小值。 |
1 |
| Maximum |
number |
数字最大值。 |
10 |
| Required |
boolean |
是否必填。 |
false |
| System |
boolean |
是否是系统字段。 |
false |
| Disabled |
boolean |
是否被禁用。 |
false |
| Array |
boolean |
是否是数组。 |
false |
| ReadOnly |
boolean |
是否只读。 |
false |
| EditorType |
string |
编辑器类型。 |
textbox |
| Attributes |
string |
扩展属性。 |
{} |
| DisplayOrder |
integer |
列表展示顺序。 |
1 |
| CreatedTime |
integer |
创建时间。格式为 Unix 时间戳,单位为毫秒。 |
1717664210000 |
| UpdatedTime |
integer |
更新时间。格式为 Unix 时间戳,单位为毫秒。 |
1717664210000 |
| Creator |
string |
创建者。 |
cretor-xxx@ccc-test |
| RequestId |
string |
请求 ID。 |
30C7D235-DDCF-4C7F-A462-5E2598252C2B |
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| Code |
string |
响应码。 |
OK |
| Message |
string |
响应信息。 |
无 |
| Params |
array |
错误参数列表。 |
|
|
string |
错误参数。 |
无 |
示例
正常返回示例
JSON格式
{
"Data": {
"InstanceId": "ccc-test",
"TemplateId": "43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492\n",
"CategoryId": "8939-4223-86d0-6bd187905cc8",
"Name": "测试模板",
"State": "Enabled",
"Editor": "editor-xxx@ccc-test",
"PropertyList": [
{
"DisplayName": "DisplayName-A",
"Description": "Description-xxxx",
"Name": "Name-A",
"DataType": "string\n",
"Pattern": "^",
"PatternErrorMessage": "不是有效的email地址\n",
"MinLength": 1,
"MaxLength": 30,
"Minimum": 1,
"Maximum": 10,
"Required": false,
"System": false,
"Disabled": false,
"Array": false,
"ReadOnly": false,
"EditorType": "textbox",
"Attributes": "{}",
"DisplayOrder": 1,
"CreatedTime": 1717664210000,
"UpdatedTime": 1717664210000,
"Creator": "cretor-xxx@ccc-test\n"
}
]
},
"RequestId": "30C7D235-DDCF-4C7F-A462-5E2598252C2B",
"HttpStatusCode": 200,
"Code": "OK",
"Message": "无",
"Params": [
"无"
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 404 | NotExists.InstanceId | The specified instance %s does not exist. | 指定的呼叫中心实例不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。