探马前端SDK使用文档
  1. 企微SDK相关
探马前端SDK使用文档
  • 调用探马SDK的说明
  • 常见Q&A
  • 完全桥接企微的SDK
  • 企微SDK相关
    • 发送消息到当前聊天框
    • 跳转到存在的群聊中
    • 创建群聊&打开客户会话
    • 发送内嵌iframe链接的H5链接卡片
    • 发送内嵌iframe链接的小程序卡片
    • 获取当前的聊天环境
  • 探马数据传输相关
    • 获取当前登录者的信息
    • 获取当前聊天框对应客户信息
    • 获取当前探马详情页面展示的客户信息
    • 根据指定的externalId(外部联系人id)获取对应的客户信息
    • 获取当前聊天中的群的群信息
    • 根据指定的chatId(群id)获取对应的群信息
  • 浏览器交互相关
    • 打开一个winodw窗口
    • 关闭当前的所处的window窗口
    • 父页面执行返回上级页面
    • 跳转到指定的探马客户详情
  1. 企微SDK相关

发送消息到当前聊天框

方法名:sendMsgToQWChat
描述:调用该接口可从聊天工具栏或附件栏打开的页面中向当前会话发送消息,消息格式支持文本(“text”),图片(“image”),视频(“video”),文件(“file”),H5(“news”)和小程序(“miniprogram”);
条件:仅限对话框存在的侧边栏页面
参数与示例:
参数:
字段类型描述必填
msgtypeString消息基本类型是
enterChatBoolean是否进入会话关闭页面,移动端生效是
消息基本类型Object描述类型的对象,见示例代码是
返回:
示例:
1.
发送文本类型
$TanmaAPI.sendMsgToQWChat({
  msgtype: "text", //消息类型,必填
  enterChat: false, //为true时表示发送完成之后顺便进入会话,仅移动端3.1.10及以上版本支持该字段
  text: {
    content: "你好", //文本内容
  }
})
2.
发送图片类型
$TanmaAPI.sendMsgToQWChat({
  msgtype: "image", //消息类型,必填
  enterChat: false, //为true时表示发送完成之后顺便进入会话,仅移动端3.1.10及以上版本支持该字段
  // 以下为第三个参数每种类型选其中之一即可,msgtype要与第三个参数的key一一对应
  image: {
    mediaid: "", //图片的素材id(传url,探马来转换成mediaid)
  }
})
3.
发送视频类型
$TanmaAPI.sendMsgToQWChat({
  msgtype: "video", //消息类型,必填
  enterChat: false, //为true时表示发送完成之后顺便进入会话,仅移动端3.1.10及以上版本支持该字段
  // 以下为第三个参数每种类型选其中之一即可,msgtype要与第三个参数的key一一对应
  video: {
    mediaid: "", //图片的素材id(传url,探马来转换成mediaid)
  }
})
4.
发送普通文件类型
$TanmaAPI.sendMsgToQWChat({
  msgtype: "file", //消息类型,必填
  enterChat: false, //为true时表示发送完成之后顺便进入会话,仅移动端3.1.10及以上版本支持该字段
  // 以下为第三个参数每种类型选其中之一即可,msgtype要与第三个参数的key一一对应
  file: {
    mediaid: "", //图片的素材id(传url,探马来转换成mediaid)
  }
})
5.
发送超链接(卡片类型)
$TanmaAPI.sendMsgToQWChat({
  msgtype: "news", //消息类型,必填
  enterChat: false, //为true时表示发送完成之后顺便进入会话,仅移动端3.1.10及以上版本支持该字段
  // 以下为第三个参数每种类型选其中之一即可,msgtype要与第三个参数的key一一对应
  news: {
    link: "", //H5消息页面url 必填
    title: "", //H5消息标题
    desc: "", //H5消息摘要
    imgUrl: "", //H5消息封面图片URL
  }
})
6.
发送小程序类型
$TanmaAPI.sendMsgToQWChat({
  msgtype: "miniprogram", //消息类型,必填
  enterChat: false, //为true时表示发送完成之后顺便进入会话,仅移动端3.1.10及以上版本支持该字段
  // 以下为第三个参数每种类型选其中之一即可,msgtype要与第三个参数的key一一对应
  miniprogram: {
    appid: "wx8bd80126147df384",//小程序的appid,企业已关联的任一个小程序
    title: "this is title", //小程序消息的title
    imgUrl: "https://search-operate.cdn.bcebos.com/d054b8892a7ab572cb296d62ec7f97b6.png",//小程序消息的封面图。必须带http或者https协议头,否则报错 $apiName$:fail invalid imgUrl
    page: "/index/page.html", //小程序消息打开后的路径,注意要以.html作为后缀,否则在微信端打开会提示找不到页面
  }
})
修改于 大约 3 年前
上一页
完全桥接企微的SDK
下一页
跳转到存在的群聊中
Built with