为了让开发者更灵活地管理用户，开发者可以使用接口对公众平台的分组进行查询、创建、修改操作，也可以使用接口在需要时移动用户到某个分组。

目录

[隐藏]1创建分组

1.1请求说明

1.2请求参数

1.3返回说明

1.4返回参数

1.5异常返回说明

2查询所有分组

2.1请求说明

2.2请求参数

2.3返回说明

2.4返回参数

2.5异常返回说明

3修改分组名

3.1请求说明

3.2请求参数

3.3返回说明

3.4返回参数

3.5异常返回说明

4移动用户分组

4.1请求说明

4.2请求参数

4.3返回说明

4.4返回参数

4.5异常返回说明

创建分组

一个公众账号，最多支持创建20个分组。

请求说明

http请求方式:POST（请使用https协议）

https://api.yixin.im/cgi-bin/groups/create?access_token=ACCESS_TOKEN

POST数据格式:json

POST数据例子:{"group":{"name":"yixintest"}}

请求参数

参数是否必须描述

access_token是调用接口凭证

name是分组名称(12个字符以内)

返回说明

{"group":{"id":85007,"name":"yixintest"}}

返回参数

参数描述

id分组id，由易信分配。

name分组名，UTF8编码

errcode接口返回码，0成功，其他都为失败

errmsg接口返回信息，若成功,返回返"请求成功",否则回具体失败原因

异常返回说明

{"errcode":40014,"errmsg":"不合法的access_token"}

全局返回码说明

查询所有分组

请求说明

http请求方式:GET（请使用https协议）

https://api.yixin.im/cgi-bin/groups/get?access_token=ACCESS_TOKEN

请求参数

access_token调用接口凭证

参数是否必须描述

access_token是调用接口凭证

返回说明

{

"groups":[

{

"id":0,

"name":"未分组",

"count":2

},

{

"id":1,

"name":"黑名单",

"count":0

},

{

"id":2,

"name":"星标组",

"count":0

},

{

"id":85003,

"name":"网易-易信",

"count":0

},

{

"id":85004,

"name":"★测试组★",

"count":0

}

]

}

返回参数

参数描述

id分组id，由易信分配。

name分组名，UTF8编码

count分组成员个数

errcode接口返回码，0成功，其他都为失败

errmsg接口返回信息，若成功,返回返"请求成功",否则回具体失败原因

异常返回说明

{"errcode":40014,"errmsg":"不合法的access_token"}

全局返回码说明

修改分组名

请求说明

http请求方式:POST（请使用https协议）

https://api.yixin.im/cgi-bin/groups/update?access_token=ACCESS_TOKEN

POST数据格式:json

POST数据例子:{"group":{"id":85007,"name":"yixin_modify"}}

请求参数

参数是否必须描述

access_token是调用接口凭证

id是分组id，由易信分配

name是分组名称(12个字符以内)

返回说明

{"errcode":0,"errmsg":"请求成功"}

返回参数

参数描述

errcode接口返回码，0成功，其他都为失败

errmsg接口返回信息，若成功,返回返"请求成功",否则回具体失败原因

异常返回说明

{"errcode":40014,"errmsg":"不合法的access_token"}

全局返回码说明

移动用户分组

请求说明

http请求方式:POST（请使用https协议）

https://api.yixin.im/cgi-bin/groups/members/update?access_token=ACCESS_TOKEN

POST数据格式:json

POST数据例子:{"openid":"72201de2f279188e","to_groupid":85003}

请求参数

参数是否必须描述

access_token是调用接口凭证

openid是用户唯一标识符

to_groupid是分组id

返回说明

{"errcode":0,"errmsg":"请求成功"}

返回参数

参数描述

errcode接口返回码，0成功，其他都为失败

errmsg接口返回信息，若成功,返回返"请求成功",否则回具体失败原因

异常返回说明

{"errcode":40014,"errmsg":"不合法的access_token"}