Name

QQ::weixin::work::appchat

DESCRIPTION

发送消息到群聊会话

FUNCTION

create(access_token, hash);

创建群聊会话 最后更新:2022/08/18

SYNOPSIS

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

请求说明:

请求包结构体为:

{
	"name" : "NAME",
	"owner" : "userid1",
	"userlist" : ["userid1", "userid2", "userid3"],
	"chatid" : "CHATID"
}

参数说明:

	参数	必须	说明
    access_token	是	调用接口凭证
    name	否	群聊名,最多50个utf8字符,超过将截断
    owner	否	指定群主的id。如果不指定,系统会随机从userlist中选一人作为群主
    userlist	是	群成员id列表。至少2人,至多2000人
    chatid	否	群聊的唯一标志,不能与已有的群重复;字符串类型,最长32个字符。只允许字符0-9及字母a-zA-Z。如果不填,系统会随机生成群id

权限说明

只允许企业自建应用调用,且应用的可见范围必须是根部门;

限制说明:

群成员人数不可超过管理端配置的“群成员人数上限”,且最大不可超过2000人; 每企业创建群数不可超过1000/天;

RETURN 返回结果

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

RETURN 参数说明

	参数	    说明
    errcode	返回码
    errmsg	对返回码的文本描述内容
    chatid	群聊的唯一标志

注意:刚创建的群,如果没有下发消息,在企业微信不会出现该群。

update(access_token, hash);

修改群聊会话 最后更新:2023/04/13

SYNOPSIS

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

请求说明:

请求包结构体为:

{
	"chatid" : "CHATID",
	"name" : "NAME",
	"owner" : "userid2",
	"add_user_list" : ["userid1", "userid2", "userid3"],
	"del_user_list" : ["userid3", "userid4"]
}

参数说明:

	参数	必须	说明
    access_token	是	调用接口凭证
    chatid	是	群聊id
    name	否	新的群聊名。若不需更新,请忽略此参数。最多50个utf8字符,超过将截断
    owner	否	新群主的id。若不需更新,请忽略此参数
    add_user_list	否	添加成员的id列表
    del_user_list	否	踢出成员的id列表

权限说明

只允许企业自建应用调用,且应用的可见范围必须是根部门。

限制说明:

chatid所代表的群必须是该应用所创建。 群成员人数不可超过2000人。 每企业变更群的次数不可超过1000次/小时。

RETURN 返回结果

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

RETURN 参数说明

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

get(access_token, chatid);

获取群聊会话 最后更新:2023/04/13

SYNOPSIS

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

请求说明:

参数说明:

	参数	            必须	说明
    access_token	是	调用接口凭证
    chatid	是	群聊id

权限说明:

只允许企业自建应用调用,且应用的可见范围必须是根部门; chatid所代表的群必须是该应用所创建; 第三方不可调用。

RETURN 返回结果:

    {
	   "errcode" : 0,
	   "errmsg" : "ok",
	   "chat_info" : {
		  "chatid" : "CHATID",
		  "name" : "NAME",
		  "owner" : "userid2",
		  "userlist" : ["userid1", "userid2", "userid3"]
	   }
	 }

RETURN 参数说明

	参数	    说明
    errcode	返回码
    errmsg	对返回码的文本描述内容
    chat_info	群聊信息
    chatid	群聊唯一标志
    name	群聊名
    owner	群主id
    userlist	群成员id列表

send(access_token, hash);

应用推送消息 最后更新:2024/01/10

SYNOPSIS

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

请求说明:

应用支持推送文本、图片、视频、文件、图文等类型。

请求包结构体为:

各个消息类型的具体POST格式参考后面消息类型说明

参数说明:

	参数	            必须	说明
    access_token	是	调用接口凭证

权限说明

只允许企业自建应用调用,且应用的可见范围必须是根部门。

限制说明:

chatid所代表的群必须是该应用所创建。 每企业消息发送量不可超过2万人次/分,不可超过30万人次/小时(若群有100人,每发一次消息算100人次)。 出于对成员的保护,每个成员在群中收到的同一个应用的消息不可超过200条/分,1万条/天,超过会被丢弃,而接口不会报错。(若应用创建了两个群,成员张三同时在这两个群中,应用往第一个群发送1条消息,再往第二个群发送2条消息,则张三累计收到该应用3条消息)。

RETURN 返回结果

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

RETURN 参数说明

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