查询企业当前可用的会议纪要模板列表(含系统预置与企业自定义模板),并在列表中内嵌返回模板绑定的 Word 版式信息。第三方系统可通过本接口发现 Console 已配置的模板编码 templateCode,用于后续纪要相关调用。
此接口只支持 签名2.0。
默认接口请求频率限制:20次/秒
REST URL
GET https://sdk.xylink.com/api/rest/external/{version}/meeting/templates/query?enterpriseId=XXX请求参数说明
参数 | 参数类型 | 参数位置 | 是否必须 | 默认值 | 说明 | 初始平台 |
enterpriseId | String | Query | 是 | 无 | 企业的唯一标识(应用级鉴权使用的 extId) | 5.2 |
signature | String | Query | 是 | 无 | 签名字符串,详见签名2.0说明 | 5.2 |
meetingRoomNumber | String | Query | 否 | 无 | 会议室号。传入时返回企业级可用模板 + 该会议室可用自定义模板;不传则返回当前企业全部可用模板 | 5.2 |
includeTemplatePreview | Boolean | Query | 否 | false | 是否返回模板预览内容。true 返回预览文本;false 时 templatePreview 固定为空字符串 "" | 5.2 |
pageIndex | Integer | Query | 否 | 1 | 页码,从 1 开始;小于等于 0 返回 400 | 5.2 |
pageSize | Integer | Query | 否 | 20 | 每页条数,取值范围 [1, 200];非法值返回 400 | 5.2 |
返回参数说明
参数 | 参数类型 | 说明 |
total | Integer | 符合条件的模板总数 |
templates | Array | 当前页模板列表 |
templates[].templateCode | String | 模板编码,格式为 promptCode|version;用于后续纪要相关调用。注意:与预约侧 minutesTemplateId 不是同一标识,不可混用 |
templates[].templateName | String | 模板名称 |
templates[].templateType | String | 模板类型:enterprise(企业级)或 room(会议室级) |
templates[].meetingRoomNumber | String | 会议室号;仅当 templateType=room 时有值,enterprise 时为 null |
templates[].wordStyleId | String | 绑定的 Word 版式 ID;模板未单独绑定版式时返回系统默认版式 ID |
templates[].wordStyleName | String | 绑定的 Word 版式名称 |
templates[].templatePreview | String | 模板预览内容。includeTemplatePreview=false 时为空字符串 "" |
返回示例
{"total": 22,
"templates": [
{"templateCode": "1779089398647000002|1781504943002",
"templateName": "审计委员会会议记录(模板二)",
"templateType": "enterprise",
"meetingRoomNumber": null,
"wordStyleId": "2079089398647100002",
"wordStyleName": "董事会审计委员会会议记录(模板二)",
"templatePreview": ""
},
{"templateCode": "2016714661563473921|1769657218673",
"templateName": "时间摘要-领导用",
"templateType": "room",
"meetingRoomNumber": "9080028153",
"wordStyleId": "2020702055756337152",
"wordStyleName": "系统默认模板",
"templatePreview": ""
}
]
}
通用错误码请参考 小鱼RESTAPI错误码。本接口特有错误如下:
错误码 | 接口提示 | 说明 |
1001 | pageIndex must be >= 1, actual: {n} | pageIndex 非法(小于等于 0) |
1001 | pageSize must be in [1, 200], actual: {n} | pageSize 非法(小于等于 0 或大于 200) |