管理角色接口 | 微信开放文档

# 管理角色接口

“推广角色”是商户内部对推广员的分类（比如不同等级的导购），用于帮助商户精细化管理推广员（比如分角色查看数据、群发消息等）。平台提供默认角色“推广员”，商家可按需新增其他角色。

# 一、新增角色

# 接口说明

单个商家最多拥有100个推广角色。

# 请求地址

POST https://api.weixin.qq.com/promoter/addrole?access_token=ACCESS_TOKEN

# 请求参数

注：本文档所有字符串长度均取string.length()，字符串以utf8编码，一个汉字长度为3

参数	类型	是否必填	说明
name	string	是	角色名称，长度不能超过50个字符
desc	string	否	角色描述，长度不能超过200个字符

# 请求示例

{
  "name": "xxxxx",
  "desc": "xxxxx"
}

# 返回值

属性	类型	说明
role_id	uint32	角色 id
name	string	角色名称
desc	string	角色描述
errcode	int32	错误码
errmsg	string	错误信息

# 返回数据示例

{
  "role_id": 2,
  "name": "xxxxx",
  "desc": "xxxxx",
  "errcode": 0,
  "errmsg": ok"
}

# 二、查询角色

# 请求地址

POST https://api.weixin.qq.com/promoter/getrole?access_token=ACCESS_TOKEN

# 请求参数

注：本文档所有字符串长度均取string.length()，字符串以utf8编码，一个汉字长度为3

参数	类型	是否必填	说明
role_id	uint32	否	角色id

# 请求示例

{
  "role_id": 1
}

# 返回值

属性	类型	说明
role_id	uint32	角色 id
name	string	角色名称
desc	string	角色描述
total_cnt	uint32	角色总数
errcode	int32	错误码
errmsg	string	错误信息

# 返回数据示例

{
  "role_list":
  [
    {
      "role_id": 1,
      "name": "xxxxx",
      "desc": "xxxxx"
    },
    {
      "role_id": 2,
      "name": "xxxxx",
      "desc": "xxxxx"
    }
  ],
  "total_cnt": 2,
  "errcode": 0,
  "errmsg": "OK"
}

# 三、修改角色

# 请求地址

POST https://api.weixin.qq.com/promoter/updaterole?access_token=ACCESS_TOKEN

# 请求参数

注：本文档所有字符串长度均取string.length()，字符串以utf8编码，一个汉字长度为3

参数	类型	是否必填	说明
role_id	uint32	是	角色id
name	string	name和desc二者必填其一	角色名称，长度不能超过50个字符
desc	string	name和desc二者必填其一	角色描述，长度不能超过200个字符

注："推广员"是默认角色，不可更改，更改会返回103001（参数错误）。如果库中已有相同角色名，修改时会返回103003（重复记录）。

# 请求示例

{
  "role_id": 1,
  "name": "xxxxx",
  "desc": "xxxxx"
}

# 返回值

属性	类型	说明
errcode	int32	错误码
errmsg	string	错误信息

# 返回数据示例

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