企业内部开发 服务端API 客户联系 客户朋友圈 客户朋友圈规则组管理
客户朋友圈规则组管理

目录

  • 获取规则组列表
  • 获取规则组详情
  • 获取规则组管理范围
  • 创建新的规则组
  • 编辑规则组及其管理范围
  • 删除规则组
  •  

    权限说明:

     

    获取规则组列表

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

     

    请求方式: POST(HTTP)

    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/moment_strategy/list?access_token=ACCESS_TOKEN

    请求示例:

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

     

    参数说明:

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

     

    返回结果:

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

    参数说明:

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

     

    获取规则组详情

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

     

    请求方式: POST(HTTP)

    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/moment_strategy/get?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"strategy_id":1
    }

    参数说明:

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

    返回结果:

    {
    	"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
    		}
    	}
    }

    参数说明:

    参数说明
    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

     

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

    获取规则组管理范围

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

     

    请求方式: POST(HTTP)

    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/moment_strategy/get_range?access_token=ACCESS_TOKEN

    请求示例:

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

    参数说明:

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

     

    返回结果:

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

    参数说明:

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

    创建新的规则组

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

    请求方式: POST(HTTP)

    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/moment_strategy/create?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"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个节点

    返回结果:

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

    参数说明:

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

     

    编辑规则组及其管理范围

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

    请求方式: POST(HTTP)

    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/moment_strategy/edit?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"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个节点

    返回结果:

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

    参数说明:

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

     

    删除规则组

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

    请求方式: POST(HTTP)

    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/moment_strategy/del?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"strategy_id":1
    }

    参数说明:

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

     

    返回结果:

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

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    上一篇
    获取客户朋友圈全部的发表记录
    下一篇
    创建企业群发