The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
QQ-weixin-work-v0.10
River stage zero No dependents
1 ++
/ QQ::weixin::work::externalcontact::moment_strategy

Name

QQ::weixin::work::externalcontact::moment_strategy

DESCRIPTION

客户朋友圈规则组管理 最后更新：2023/12/01

SYNOPSIS

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

FUNCTION

权限说明

调用客户朋友圈规则组相关接口的应用需要满足如下的权限：

        应用类型    权限要求
        自建应用    配置到「客户联系 可调用接口的应用」中
        代开发应用   具有「管理客户朋友圈规则组」权限
        第三方应用   具有「管理客户朋友圈规则组」权限

提示 应用仅能获取和管理由本应用创建的规则组

注： 从2023年12月1日0点起，不再支持通过系统应用secret调用接口，存量企业暂不受影响 查看详情

list(access_token, hash);

获取规则组列表

SYNOPSIS

https://developer.work.weixin.qq.com/document/path/94890#获取规则组列表

请求说明：

企业可通过此接口获取企业配置的所有客户朋友圈规则组id列表。

请求包结构体为：

    {
                "cursor":"CURSOR",
                "limit":1000
        }

参数说明：

        参数                  必须  说明
    access_token        是       调用接口凭证
        cursor  否       分页查询游标，首次调用可不填
        limit   否       分页大小,默认为1000，最大不超过1000

RETURN 返回结果：

    {
                "errcode": 0,
                "errmsg": "ok",
                "strategy":
                [
                        {
                                "strategy_id":1
                        },
                        {
                                "strategy_id":2
                        }
                ],
                "next_cursor":"NEXT_CURSOR"
        }

RETURN 参数说明：

        参数              说明
    errcode     返回码
        errmsg  对返回码的文本描述内容
        strategy_id     规则组id
        next_cursor     分页游标，用于查询下一个分页的数据，无更多数据时不返回

get(access_token, hash);

获取规则组详情

SYNOPSIS

https://developer.work.weixin.qq.com/document/path/94890#获取规则组详情

请求说明：

企业可以通过此接口获取某个客户朋友圈规则组的详细信息。

请求包结构体为：

    {
                "strategy_id":1
        }

参数说明：

        参数                  必须  说明
    access_token        是       调用接口凭证
        strategy_id     是       规则组id

RETURN 返回结果：

    {
                "errcode": 0,
                "errmsg": "ok",
                "strategy": {
                        "strategy_id":1,
                        "parent_id":0,
                        "strategy_name": "NAME",
                        "create_time": 1557838797,
                        "admin_list":[
                                "zhangsan",
                                "lisi"
                        ],
                        "privilege":
                        {
                                "view_moment_list":true,
                                "send_moment":true,
                                "manage_moment_cover_and_sign":true
                        }
                }
        }

RETURN 参数说明：

        参数              说明
    errcode     返回码
        errmsg  对返回码的文本描述内容
        strategy_id     规则组id
        parent_id       父规则组id， 如果当前规则组没父规则组，则为0
        strategy_name   规则组名称
        create_time     规则组创建时间戳
        admin_list      规则组管理员userid列表
        privilege.view_moment_list      允许查看成员的全部客户朋友圈发表
        privilege.send_moment   允许成员发表客户朋友圈，默认为true
        privilege.manage_moment_cover_and_sign  配置封面和签名，默认为true

如果规则组具有父规则组则其管理范围必须是父规则组的子集。

get_range(access_token, hash);

获取规则组管理范围

SYNOPSIS

https://developer.work.weixin.qq.com/document/path/94890#获取规则组管理范围

请求说明：

企业可通过此接口获取某个朋友圈规则组管理的成员和部门列表

请求包结构体为：

    {
                "strategy_id":1,
                "cursor":"CURSOR",
                "limit":1000
        }

参数说明：

        参数                  必须  说明
    access_token        是       调用接口凭证
        strategy_id     是       规则组id
        cursor  否       分页游标
        limit   否       每个分页的成员/部门节点数，默认为1000，最大为1000

RETURN 返回结果：

    {
                "errcode": 0,
                "errmsg": "ok",
                "range":
                [
                        {
                                "type":1,
                                "userid":"zhangsan"
                        },
                        {
                                "type":2,
                                "partyid":1
                        }
                ],
                "next_cursor":"NEXT_CURSOR"
        }

RETURN 参数说明：

        参数              说明
    errcode     返回码
        errmsg  对返回码的文本描述内容
        range.type      节点类型，1-成员 2-部门
        range.userid    管理范围内配置的成员userid，仅type为1时返回
        item.partyid    管理范围内配置的部门partyid，仅type为2时返回
        next_cursor     分页游标，用于查询下一个分页的数据，无更多数据时不返回

create(access_token, hash);

创建新的规则组

SYNOPSIS

https://developer.work.weixin.qq.com/document/path/94890#创建新的规则组

请求说明：

企业可通过此接口创建一个新的客户朋友圈规则组。该接口仅支持串行调用，请勿并发创建规则组。

请求包结构体为：

    {
                "parent_id":0,
                "strategy_name": "NAME",
                "admin_list":[
                        "zhangsan",
                        "lisi"
                ],
                "privilege"
                {
                                "send_moment":true,
                                "view_moment_list":true,
                                "manage_moment_cover_and_sign":true
                },
                "range":
                [
                        {
                                "type":1,
                                "userid":"zhangsan"
                        },
                        {
                                "type":2,
                                "partyid":1
                        }
                ]
        }

参数说明：

        参数                  必须  说明
    access_token        是       调用接口凭证
        parent_id       否       父规则组id
        strategy_name   是       规则组名称
        admin_list      是       规则组管理员userid列表，不可配置超级管理员，每个规则组最多可配置20个负责人
        privilege.view_moment_list      否       允许查看成员的全部客户朋友圈发表，默认为true
        privilege.send_moment   否       允许成员发表客户朋友圈，默认为true
        privilege.manage_moment_cover_and_sign  否       配置封面和签名，默认为true
        range.type      是       规则组管理范围节点类型，1-成员 2-部门
        range.userid    否       规则组的管理成员id
        range.partyid   否       规则组的管理部门id

如果要创建的规则组具有父规则组，则其管理范围必须是父规则组的子集，且将完全继承父规则组的权限配置(privilege将被忽略) 管理组的最大层级为5层 每个管理组的管理范围内最多支持3000个节点

RETURN 返回结果：

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

RETURN 参数说明：

        参数              说明
    errcode     返回码
        errmsg  对返回码的文本描述内容
        strategy_id     规则组id

edit(access_token, hash);

编辑规则组及其管理范围

SYNOPSIS

https://developer.work.weixin.qq.com/document/path/94890#编辑规则组及其管理范围

请求说明：

企业可通过此接口编辑规则组的基本信息和修改客户朋友圈规则组管理范围。该接口仅支持串行调用，请勿并发修改规则组。

请求包结构体为：

    {
                "strategy_id":1,
                "strategy_name": "NAME",
                "admin_list":[
                        "zhangsan",
                        "lisi"
                ],
                "privilege":
                {
                        "view_moment_list":true,
                        "send_moment":true,
                        "manage_moment_cover_and_sign":true
                },
                "range_add":
                [
                        {
                                "type":1,
                                "userid":"zhangsan"
                        },
                        {
                                "type":2,
                                "partyid":1
                        }
                ],
                "range_del":
                [
                        {
                                "type":1,
                                "userid":"lisi"
                        },
                        {
                                "type":2,
                                "partyid":2
                        }
                ]
        }

参数说明：

        参数                  必须  说明
    access_token        是       调用接口凭证
        strategy_id     是       规则组id
        strategy_name   否       规则组名称
        admin_list      否       管理员列表，如果为空则不对负责人做编辑，如果有则覆盖旧的负责人列表
        privilege       否       权限配置，如果为空则不对权限做编辑，如果有则覆盖旧的权限配置
        range_add.type  否       向管理范围添加的节点类型 1-成员 2-部门
        range_add.userid        否       向管理范围添加成员的userid,仅type为1时有效
        range_add.partyid       否       向管理范围添加部门的partyid，仅type为2时有效
        range_del.type  否       从管理范围删除的节点类型 1-成员 2-部门
        range_del.userid        否       从管理范围删除的成员的userid,仅type为1时有效
        range_del.partyid       否       从管理范围删除的部门的partyid，仅type为2时有效

如果规则组具有父规则组，则其管理范围必须是父规则组的子集，且将完全继承父规则组的权限配置(privilege将被忽略) 每个管理组的管理范围内最多支持3000个节点

RETURN 返回结果：

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

RETURN 参数说明：

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

del(access_token, hash);

删除规则组

SYNOPSIS

https://developer.work.weixin.qq.com/document/path/94890#删除规则组

请求说明：

企业可通过此接口删除某个客户朋友圈规则组。

请求包结构体为：

    {
                "strategy_id":1
        }

参数说明：

        参数                  必须  说明
    access_token        是       调用接口凭证
        strategy_id     是       规则组id

RETURN 返回结果：

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

RETURN 参数说明：

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