查询用户合同类型
1. 接口描述
接口请求域名： essbasic.tencentcloudapi.com 。
查询用户模版类型，分为两种模式：
- QueryBindTemplate:false，查询用户合同模版类型，返回用户合同模版类型ID，用户合同模版类型名称，用户合同模版类型描述信息
- QueryBindTemplate:false，查询用户合同模版类型，返回用户合同模版类型ID，用户合同模版类型名称，用户合同模版类型描述信息，被绑定的模版数量
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeUserFlowType。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-26。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Agent | 是 | Agent | 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
|
| Filters.N | 否 | Array of Filter | 搜索过滤的条件，本字段允许您通过指定模板 ID 或模板名称来进行查询。
|
| QueryBindTemplate | 否 | Boolean | 查询绑定了模版的用户合同类型
示例值：true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AllUserFlowTypes | Array of TemplateUserFlowType | 查询到的所有用户合同类型列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询用户合同类型（不指定filter）
查询用户合同类型（不指定filter）
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserFlowType
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
}
}
输出示例
{
"Response": {
"AllUserFlowTypes": [
{
"Description": "",
"Name": "单方合同",
"TemplateNum": 0,
"UserFlowTypeId": "yDwXXUUckp19hvn8URxp4X6wVwCLodxJ"
}
],
"RequestId": "s1741681654595707818"
}
}
示例2 查询用户合同类型（不指定查询绑定模版的合同类型）
查询用户合同类型（不指定查询绑定模版的合同类型）
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserFlowType
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"QueryBindTemplate": false
}
输出示例
{
"Response": {
"AllUserFlowTypes": [
{
"Description": "",
"Name": "单方合同",
"TemplateNum": 0,
"UserFlowTypeId": "yDwXXUUckp19hvn8URxp4X6wVwCLodxJ"
}
],
"RequestId": "s1741681654595707818"
}
}
示例3 查询用户合同类型（指定查询绑定模版的合同类型）
查询用户合同类型（指定查询绑定模版的合同类型）
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserFlowType
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"QueryBindTemplate": true
}
输出示例
{
"Response": {
"AllUserFlowTypes": [
{
"Description": "",
"Name": "单方合同",
"TemplateNum": 10,
"UserFlowTypeId": "yDwXXUUckp19hvn8URxp4X6wVwCLodxJ"
}
],
"RequestId": "s1741681654595707818"
}
}
示例4 查询用户合同类型（指定用户模版id）
查询用户合同类型（指定用户模版id）
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserFlowType
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"Filters": [
{
"Key": "user-flow-type-id",
"Values": [
"yDwXXUUckp19hvn8URxp4X6wVwCLodxJ"
]
}
],
"QueryBindTemplate": true
}
输出示例
{
"Response": {
"AllUserFlowTypes": [
{
"Description": "",
"Name": "单方合同",
"TemplateNum": 10,
"UserFlowTypeId": "yDwXXUUckp19hvn8URxp4X6wVwCLodxJ"
}
],
"RequestId": "s1741681654595707818"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| ResourceNotFound | 资源不存在。 |
