友米聚合 - 开放API
  1. 应用场景
友米聚合 - 开放API
  • 应用场景
    • 自有订单系统 嵌入 企客聊侧边栏
  • v1
    • 文档
      • 介绍
        • 开发文档阅读说明
        • 错误码返回说明
      • 入门说明
        • 生成signature
        • 获取TOKEN方法
        • 请求Headers说明
      • 接口详情
        • 基础数据类接口
        • 数据读取类接口
        • 行为操作类接口
        • 回调数据
  • v2
    • 事件发布格式说明
    • ChatMess
      • 发送消息
      • 申请接管
      • 终止接管
      • 激活会话
      • 发送通知
      • 读取聊天记录
    • Report
      • 获取员工客服统计
      • 获取员工激活客户数统计
    • System
      • 获取部门列表
      • 根据部门获得组
      • 根据组获得员工
      • 获得员工列表
    • Friend
      • 读取粉丝列表
      • 读取粉丝总数
    • Todo
      • 新增待办记录
      • 新增待办记录(返回编号)
      • 获取待办列表
      • 获取待办列表总数
    • Ad
      • 读取广告列表
      • 读取广告条数
    • BulkSend
      • 保存RPA群发
      • 删除RPA群发
    • 注册回调地址
      POST
    • 订阅事件
      POST
    • 获取商户TOKEN
      POST
  1. 应用场景

自有订单系统 嵌入 企客聊侧边栏

应用场景#

通过【企客聊客户端】点击相应的 隐藏电话/客户微信号/固定按钮,采用URL直接网页加载的方式,在侧边栏中加载相应的自有CRM系统中的页面。

准备工作#

企客聊后台:完成 企客聊后台 - 后勤 - CRM对接配置 中参数的配置
企客聊客户端(其中一端配置即可):
APP: 完成 我的 - 订单账号设置
PC: 完成 设置 - 更多设置 - 自有订单账号设置

接口规范(第三方系统能够从客户端侧边栏中获取到的参数)#

{自建CRM系统URL}?Type=WL&PKID={0}&time={1}&neber={2}&UserID={3}
参数名数据类型说明
Typestring接口类型.默认值=WL
Timestring时间戳,DateTime时间格式,精确到秒
neberstring6位随机数
PKIDstring报文体【密文】=> 使用【密钥】解密
UserIDstring自有订单用户名【密文】=> 使用【系统私钥】解密

[报文体] 明文参数说明#

UserID=&Timestamp=&WX=&TEL=&Number=&sign=&merchantid=&wechat=&uid=&originalId=&dockPwd=
参数名数据类型说明
UserIDstring自建系统用户名
dockPwdstring自建系统用户密码(可用于验证用户名是否正确,实现自动登录)
WXstring微信号
TELstring手机号码
Numberstring机号
merchantidstring商户号
originalIdstring原始微信号
wechatstring运营机微信号
uidstring预留值
Timestampint时间戳
signstring加密盐

解密规范#

系统私钥 为企客聊后台 - 后勤 - CRM对接配置 中配置的【私钥】参数
下单URL 为企客聊后台 - 后勤 - CRM对接配置 中配置的【下单url】参数
密钥 组成:系统私钥(私钥为空时默认使用下单URL) + “?sign=” + 入参随机数 + 自有订单用户名 + 入参时间戳
/// <summary>
/// 解密方法:Des3Encode(密文, 密钥)
/// </summary>
/// <param name="text"></param>
/// <param name="strKey"></param>
/// <returns></returns>
public static string Des3Decode(string text, string strKey)
{
    System.Text.Encoding utf8 = System.Text.Encoding.UTF8;
    byte[] key = build3DesKey(strKey);
    byte[] iv = new byte[] { 1, 2, 3, 4, 5, 6, 7, 8 };
    byte[] data = Convert.FromBase64String(text);
    byte[] str2 = Des3DecodeECB(key, iv, data);
    return System.Text.Encoding.UTF8.GetString(str2).TrimEnd('\0');
}

/// <summary>
/// DES3 ECB模式解密
/// </summary>
/// <param name="key">密钥</param>
/// <param name="iv">IV(当模式为ECB时,IV无用)</param>
/// <param name="str">密文的byte数组</param>
/// <returns>明文的byte数组</returns>
static byte[] Des3DecodeECB(byte[] key, byte[] iv, byte[] data)
{
    MemoryStream msDecrypt = new MemoryStream(data);
    TripleDESCryptoServiceProvider tdsp = new TripleDESCryptoServiceProvider();
    tdsp.Mode = CipherMode.ECB;
    tdsp.Padding = PaddingMode.PKCS7;
    CryptoStream csDecrypt = new CryptoStream(msDecrypt,
        tdsp.CreateDecryptor(key, iv),
        CryptoStreamMode.Read);
    byte[] fromEncrypt = new byte[data.Length];
    csDecrypt.Read(fromEncrypt, 0, fromEncrypt.Length);
    return fromEncrypt;
}

/// <summary>
/// 装成24位字节数组
/// </summary>
/// <param name="keyStr"></param>
/// <returns></returns>
static byte[] build3DesKey(String keyStr)
{
    System.Text.Encoding utf8 = System.Text.Encoding.UTF8;
    byte[] key = new byte[24];
    byte[] temp = utf8.GetBytes(keyStr);
    if (key.Length > temp.Length)
    {
        System.Array.Copy(temp, 0, key, 0, temp.Length);
    }
    else
    {
        System.Array.Copy(temp, 0, key, 0, key.Length);
    }
    return key;
}


/// <summary>
/// base64转string
/// </summary>
/// <param name="text"></param>
/// <returns></returns>
public static string getbase64tostring(string text)
{
    byte[] data = Convert.FromBase64String(text);
    return System.Text.Encoding.UTF8.GetString(data).TrimEnd('\0');
}

交互场景(第三方系统通过公共接口与企客聊客户端实现交互)#

企客聊适用接口(所需参数均可从客户端同步到第三方系统的数据以及其他读取数据接口中获得):#
运营号配置(用于同步运营号信息,用于下面接口调用):http://langscloud.gitee.io/helpapi/#/APIHelp/jichulei?id=%e8%bf%90%e8%90%a5%e5%8f%b7%e9%85%8d%e7%bd%ae
添加待办:http://langscloud.gitee.io/helpapi/#/APIHelp/xinwei?id=%e6%b7%bb%e5%8a%a0%e5%be%85%e5%8a%9e
激活会话:http://langscloud.gitee.io/helpapi/#/APIHelp/xinwei?id=%e6%bf%80%e6%b4%bb%e4%bc%9a%e8%af%9d
变更归属:http://langscloud.gitee.io/helpapi/#/APIHelp/xinwei?id=%e4%bf%ae%e6%94%b9%e8%81%9a%e5%90%88%e8%81%8a%e5%a4%a9%e5%bd%92%e5%b1%9e
下一页
开发文档阅读说明
Built with