接口描述
查询已创建的合同模板列表。
【注】仅限查询通过API接口创建的模板，在e签宝官网中制作的模板不支持查询。
接口地址&请求方法
接口地址：https://{host}/v3/doc-templates?pageNum=1&pageSize=20
请求方法：GET
请求头格式
具体请求头参数，请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
pageNum | int32 | 否 | query | 查询页码（默认值 1） |
pageSize | int32 | 否 | query | 每页显示的数量，最大值：20（默认值 20） |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | ||
code | int32 | 是 | 业务码，0表示成功，非0表示异常。 | ||
message | string | 否 | 业务信息 请根据 code 来判断错误情况，不应该依赖message 匹配，因为message 可能会调整。 | ||
data（点击“+”展开详情） | object | 否 | 业务数据 | ||
total | int32 | 否 | 查询结果中模板的总数量 | ||
docTemplates（点击“+”展开详情） | array | 否 | 合同模板列表 | ||
docTemplateId | string | 否 | 合同模板ID | ||
docTemplateName | string | 否 | 合同模板名称 | ||
createTime | int64 | 否 | 合同模板创建时间（Unix时间戳格式，单位：毫秒） | ||
updateTime | int64 | 否 | 合同模板更新时间（Unix时间戳格式，单位：毫秒） | ||
请求示例
GET https://openapi.esign.cn/v3/doc-templates?pageNum=1&pageSize=20响应示例
{
"code": 0,
"message": "成功",
"data": {
"total": 2,
"docTemplates": [
{
"docTemplateName": "模板一",
"docTemplateId": "8726f6b9***1a56d",
"createTime": 1649389616000,
"updateTime": 1649389616000
},
{
"docTemplateName": "模板二",
"docTemplateId": "ecd09aa***967bb",
"createTime": 1635834265000,
"updateTime": 1635834265000
}
]
}
}
我要纠错