创建群聊并发送消息 - 接口文档 - 企业微信开发者中心

开发者中心

首页

教程

接口

社区

工具

第三方应用开发

快速入门服务端API 客户端API 运营规范附录更新日志联系我们

第三方应用开发客户端API JS-SDK 会话创建群聊并发送消息

创建群聊并发送消息

最后更新：2023/01/04

用于第三方应用与代开发应用向用户申请给指定群聊范围发送消息。接口调用之后，用户可在选人界面对群聊范围进行修改，当创建群聊成功时会返回新建的群聊ID。

接口定义

wx.invoke("createChatWithMsg", {
                selectedOpenUserIds: ["zhangsan","lisi"],
                selectedTickets: ["tick1","token2"],
                chatName: "discussName",
                msg: {
                	msgtype: "link",
                	link: {
                   		title: "title1",
                    		desc: "desc1",
                    		url: "link1",
                    		imgUrl: "imgurl1"
                	}
             }
        },function(res){
                if (res.err_msg == "createChatWithMsg:ok")
                {
                        var chatId = res.chatId; // 新建的会话ID，当会话为单聊时不返回此字段
                }
        }
);

此接口仅在企业微信3.1.8及以后版本支持，微信端不支持（微信开发者工具也不支持）。
必须先成功调用agentConfig，否则调用时会报“no permission”错误。
仅第三方应用与代开发应用可调用。(第三方通讯录应用不支持)

传入参数

参数名	类型	是否必须	说明
selectedOpenUserIds	StringArray	否	群聊指定的用户openUserId列表
selectedTickets	StringArray	否	群聊指定的selectedTicket列表，selectedTicket可通过selectPrivilegedContact获取
chatName	String	否	新建群聊指定的群名
msg	Message	是	发送的链接消息

Message

参数名	类型	是否必须	说明
msgtype	String	是	目前只支持链接消息，固定填link
link	LinkMessage	msgtype=="link"必填	链接消息内容

LinkMessage

参数名	类型	是否必须	说明
title	String	否	标题
desc	String	否	描述
url	String	是	链接
imgUrl	String	否	封面图

返回结果json示例说明


{
    "chatId":"wrAJ2GCAAAOVAwoK7jr12CdpdDYgce3Q",
    "err_msg":"createChatWithMsg:ok"
}

返回参数

参数名	类型	是否必须	说明
err_msg	String	是	调用成功时返回 createChatWithMsg:ok 若msgtype不合法，返回 createChatWithMsg:fail_unsupported_msgtype 若msgtype==link且msg.link.url未传，返回 createChatWithMsg:fail_msg_link_missing_url
chatId	String	否	若新建群聊时，返回对应的群聊ID。特殊情况，当发送的范围只有1人时，不会新建群聊，此时不返回chatId

分享消息到当前会话

打开个人聊天窗口schema

本节内容

创建群聊并发送消息