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

    调用探马SDK的说明


    背景:#

    在探马应用下的web页面(父页面),使用客户的页面(子页面/内嵌页面)作为探马web页面的内嵌iframe,会遇到数据通信的问题,常见的几个场景:
    企微方法:发送消息能力,打开会话能力,拉群能力
    获取探马数据:获取销售信息,获取客户信息
    window方法:打开一个window窗口,关闭窗口的能力(mac无法js触发关闭)

    使用方法:#

    1.
    引入:使用script标签的引入方式;
    开发联调地址:https://dev.tanmarket.cn/tanma-sdk-child/sdk-1.0.2.js
    测试地址:https://dev.tanmarket.cn/tanma-sdk-child/sdk.js
    生产地址:https://account.tanmarket.cn/webPlugin/tanma-sdk-sidebar/sdk.js
    私有化生产地址:私有化探马后台的域名+/webPlugin/tanma-sdk-sidebar/sdk.js
    <head>
      <meta charset="UTF-8">
      <meta http-equiv="X-UA-Compatible" content="IE=edge">
      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      // 引入js,会挂载在window对象上
      <script src="https://account.tanmarket.cn/webPlugin/tanma-sdk-sidebar/sdk.js"></script>
      <title>Document</title>
    </head>
    配置白名单:联系实施人员或技术支持,探马来配置白名单;
    2.
    调用
    <button onclick="sendChat()">发送内容</button>
    function sendChat(){
      const params = {};
      $TanmaAPI.sendMsgToQWChat(params).then(res=>{
        console.log('来自父页面的消息',res);
      }).catch(err=>{
        console.log('来自父页面的错误',err);
      })
    }

    API参数与返回值(所有API的返回格式统一如下,res.data为有效信息)#

    回调成功
    {
          type:eventMsg,//api方法名称
          code:0,
          data:res,//获取信息类,res是Object;
          message:'success',
    }
    回调失败
    {
          type:eventMsg, //api方法名称
          code:-1,
          data:null,
          message:'可信域名或调用方法不存在',
    }
    修改于 2022-07-11 11:18:56
    下一页
    常见Q&A
    Built with