第三方应用开发
小程序
基础
连接微信
办公
JS-SDK
基础
连接微信
办公
第三方应用开发
客户端API
JS-SDK
会话
创建群聊并发送消息
创建群聊并发送消息
最后更新:2025/04/09

目录

  • ww.createChatWithMsg(params)
  • 功能描述
  • 使用限制
  • 参数说明
  • params: Object
  • 返回说明
  • 错误信息
  • 旧版jweixin调用
  • 示例代码
  • ww.createChatWithMsg(params)

    兼容性:企业微信 3.1.8 开始支持

    功能描述

    向用户申请给指定范围发送消息。

    调用接口后,用户可在选人界面对群聊范围进行修改,当创建群聊成功时会返回新建的群聊 ID。

    ww.createChatWithMsg({
      selectedOpenUserIds: ['zhangsan','lisi'],
      selectedTickets: ['tick1','token2'],
      chatName: 'discussName',
      msg: {
        msgtype: 'link',
        link: {
          title: 'title1',
          desc: 'desc1',
          url: 'link1',
          imgUrl: 'imgurl1'
        }
      }
    })

    使用限制

    • 仅第三方应用(非通讯录应用)与代开发应用可调用

    • 本接口必须使用应用身份进行注册

    参数说明

    params: Object

    属性类型必填说明
    selectedOpenUserIdsstring

    群聊指定的用户 OpenUserID 列表

    selectedTicketsstring[]

    群聊指定的 selectedTicket 列表

    可通过 selectPrivilegedContact 接口获取

    chatNamestring

    新建群聊指定的群名

    msgObject

    发送的链接消息

    属性类型必填说明
    msgtype"link"

    消息类型

    linkObject
    属性类型必填说明
    titlestring

    H5消息标题

    imgUrlstring

    H5消息封面图片URL

    descstring

    H5消息摘要

    urlstring

    H5消息页面url

    successFunction

    成功回调

    failFunction

    失败回调

    cancelFunction

    取消回调

    completeFunction

    完成回调

    返回说明

    Promise<Object>

    属性类型必填说明
    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    chatIdstring

    新建群聊时返回对应的群聊 ID

    当发送的范围只有 1 人时,不会新建群聊,此时不返回 chatId

    错误信息

    errMsg说明
    createChatWithMsg:ok执行成功
    createChatWithMsg:fail_unsupported_msgtypemsgtype不合法
    createChatWithMsg:fail_msg_link_missing_urlmsg.link.url未传入

    旧版jweixin调用

    示例代码

    接口定义

    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,当会话为单聊时不返回此字段
                    }
            }
    );
    上一篇变更群成员
    下一篇打开已有群聊并发送消息
      本节内容
    服务端API
    基础
    数据与智能专区
    应用接收专区通知
    连接微信
    客户联系
    办公
    小程序接入对外收款
    客户端API
    小程序
    基础
    连接微信
    办公
    JS-SDK
    基础
    连接微信
    办公
    更新日志
    联系我们