Name

QQ::weixin::work::corpgroup::rule

DESCRIPTION

上下游规则

FUNCTION

list_ids(access_token, hash);

获取对接规则id列表 最后更新:2023/11/30

SYNOPSIS

https://developer.work.weixin.qq.com/document/path/95631

请求说明:

上下游系统应用可通过该接口获取企业上下游规则id列表

请求包结构体为:

{
   "chain_id":"Chxxxxxx"
}

参数说明:

	参数	            必须	说明
    access_token	是	调用接口凭证
    chain_id	是	上下游id

权限说明:

调用的应用需要满足如下的权限,仅适用于上下游中创建空间的主企业调用。

应用类型 权限要求 自建应用 配置到「上下游- 可调用接口的应用」中 注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情

RETURN 返回结果:

{
   "errcode": 0,
   "errmsg": "ok",
   "rule_ids": [1,2]
}

RETURN 参数说明:

	参数	        说明
    errcode	    出错返回码,为0表示成功,非0表示调用失败
    errmsg	对返回码的文本描述内容
    rule_ids	上下游关系规则的id

delete_rule(access_token, hash);

删除对接规则 最后更新:2023/11/30

SYNOPSIS

https://developer.work.weixin.qq.com/document/path/95632

请求说明:

上下游系统应用可通过该接口删除企业上下游规则

请求包结构体为:

{
   "chain_id":"Chxxxxxx",
   "rule_id":1
}

参数说明:

	参数	            必须	说明
    access_token	是	调用接口凭证
    chain_id	是	上下游id
    rule_id	是	上下游规则id

权限说明:

调用的应用需要满足如下的权限,仅适用于上下游中创建空间的主企业调用。操作的规则对应的企业成员和部门都需要在应用的可见范围内。

应用类型 权限要求 自建应用 配置到「上下游- 可调用接口的应用」中 注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情

RETURN 返回结果:

{
   "errcode": 0,
   "errmsg": "ok"
}

RETURN 参数说明:

	参数	        说明
    errcode	    返回码
    errmsg	对返回码的文本描述内容

get_rule_info(access_token, hash);

获取对接规则详情 最后更新:2023/11/30

SYNOPSIS

https://developer.work.weixin.qq.com/document/path/95633

请求说明:

上下游系统应用可通过该接口获取企业上下游规则详情

请求包结构体为:

{
   "chain_id":"Chxxxxxx",
   "rule_id":1
}

参数说明:

	参数	            必须	说明
    access_token	是	调用接口凭证
    chain_id	是	上下游id
    rule_id	是	上下游规则id

权限说明:

调用的应用需要满足如下的权限,仅适用于上下游中创建空间的主企业调用。操作的规则对应的企业用户和部门都需要在应用的可见范围内。

应用类型 权限要求 自建应用 配置到「上下游- 可调用接口的应用」中 注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情

RETURN 返回结果:

{
   "errcode": 0,
   "errmsg": "ok",
   "rule_info": {
	  "owner_corp_range": {
		 "departmentids": ["departmentid1", "departmentid2"],
		 "userids": ["userid1","userid2"]
	  },
	  "member_corp_range": {
		 "groupids": ["groupid1", "groupid2"],
		 "corpids": ["corpid1","corpid2"]
	  }
   }
}

RETURN 参数说明:

	参数	        说明
    errcode	    返回码
    errmsg	对返回码的文本描述内容
    rule_info	上下游关系规则的详情
	rule_info.owner_corp_range	上游企业的对接人规则(下游企业可以看到并联系的成员或部门)
	rule_info.owner_corp_range.departmentids	部门id
	rule_info.owner_corp_range.userids	用户id
	rule_info.member_corp_range	下游企业规则范围
	rule_info.member_corp_range.groupids	分组id
	rule_info.member_corp_range.corpids	企业id

add_rule(access_token, hash);

新增对接规则 最后更新:2023/12/07

SYNOPSIS

https://developer.work.weixin.qq.com/document/path/95634

请求说明:

上下游系统应用可通过该接口新增一条对接规则。 注意:新增和更新上下游对接规则的接口每天最多调用1000次

请求包结构体为:

{
   "chain_id":"Chxxxxxx",
   "rule_info": {
	  "owner_corp_range": {
		 "departmentids": ["departmentid1", "departmentid2"],
		 "userids": ["userid1","userid2"]
	  },
	  "member_corp_range": {
		 "groupids": ["groupid1", "groupid2"],
		 "corpids": ["corpid1","corpid2"]
	  }
   }
}

参数说明:

	参数	            必须	说明
    access_token	是	调用接口凭证
    chain_id	是	上下游id
    rule_info	是	上下游关系规则的详情
	rule_info.owner_corp_range	是	上游企业的对接人规则(下游企业可以看到并联系的成员或部门)
	rule_info.owner_corp_range.departmentids	否	部门id,部门id和用户id两个必选填一个
	rule_info.owner_corp_range.userids	否	用户id,部门id和用户id两个必选填一个
	rule_info.member_corp_range	是	下游企业规则范围
	rule_info.member_corp_range.groupids	否	分组id,分组id和企业id两个必选填一个
	rule_info.member_corp_range.corpids	否	企业id,分组id和企业id两个必选填一个

权限说明:

调用的应用需要满足如下的权限,仅适用于上下游中创建空间的主企业调用。操作的规则对应的企业用户和部门都需要在应用的可见范围内。

应用类型 权限要求 自建应用 配置到「上下游- 可调用接口的应用」中 注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情

RETURN 返回结果:

{
   "errcode": 0,
   "errmsg": "ok",
   "rule_id": 1
}

RETURN 参数说明:

	参数	        说明
    errcode	    返回码
    errmsg	对返回码的文本描述内容
    rule_id	上下游规则id

modify_rule(access_token, hash);

更新对接规则 最后更新:2023/12/07

SYNOPSIS

https://developer.work.weixin.qq.com/document/path/95635

请求说明:

上下游系统应用可通过该接口修改一条对接规则。 注意:新增和更新上下游对接规则的接口每天最多调用1000次

请求包结构体为:

{
   "chain_id":"Chxxxxxx",
   "rule_id": 1,
   "rule_info": {
	  "owner_corp_range": {
		 "departmentids": ["departmentid1", "departmentid2"],
		 "userids": ["userid1","userid2"]
	  },
	  "member_corp_range": {
		 "groupids": ["groupid1", "groupid2"],
		 "corpids": ["corpid1","corpid2"]
	  }
   }
}

参数说明:

	参数	            必须	说明
    access_token	是	调用接口凭证
    chain_id	是	上下游id
    rule_id	是	上下游规则id
    rule_info	是	上下游关系规则的详情
	rule_info.owner_corp_range	是	上游企业的对接人规则(下游企业可以看到并联系的成员或部门)
	rule_info.owner_corp_range.departmentids	否	部门id,部门id和用户id两个必选填一个
	rule_info.owner_corp_range.userids	否	用户id,部门id和用户id两个必选填一个
	rule_info.member_corp_range	是	下游企业规则范围
	rule_info.member_corp_range.groupids	否	分组id,分组id和企业id两个必选填一个
	rule_info.member_corp_range.corpids	否	企业id,分组id和企业id两个必选填一个

权限说明:

调用的应用需要满足如下的权限,仅适用于上下游中创建空间的主企业调用。操作的规则对应的企业成员和部门都需要在应用的可见范围内。

应用类型 权限要求 自建应用 配置到「上下游- 可调用接口的应用」中 注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情

RETURN 返回结果:

{
   "errcode": 0,
   "errmsg": "ok"
}

RETURN 参数说明:

	参数	        说明
    errcode	    返回码
    errmsg	对返回码的文本描述内容