云客开放接口
公共信息
云客开放接口
一、说明
1、参数配置
在云客PC端注册管理员账号
联系云客技术同事，申请接口调用权限，云客会提供
管理员的用户id（因为管理员账号是在云客PC端产生的，所以管理员的用户Id是固定的。）
企业代码，
接口签名KEY
2、账号与手机的绑定
手机以IMEI(1)作为唯一标示
账号在手机上登录之后，建立账号与手机的绑定关系（可通过/phone/bindings查询）
账号与手机绑定后，其他账号不能登录此台手机
账号与手机的绑定关系可以通过/phone/unbind解除绑定，解绑后其他账号可从此手机登录
名词解释
| 名称 | 说明 |
|---|---|
| 用户 | 您公司中使用工作手机的员工 |
| 用户Id | 您公司的员工Id，通过/user/add接口传到云客后台保存，后续的操作（如查询某员工的通话记录），都以此Id作为参数查询（用户Id作为用户的唯一标识，设置过后不支持修改）。 |
| 客户 | 您公司的客户，对应到手机端可以理解为手机的通讯录 |
| 客户Id | 您公司中的客户id，同样通过客户新增的接口传到后台保存，后续例如修改某客户的信息，以此id作为条件识别指定客户 |
请求说明
接口请求域名：https://phone.yunkecn.com
接口请求地址：接口请求域名 + 接口path
接口请求方式均为POST
请求参数与返回数据均为JSON格式（请勿使用单引号包裹 如{'key': 'value'}）
请求Header中需要计算签名
Header参数说明
| 字段 | 说明 |
|---|---|
| partnerId | 用户id，用于识别调用人，大部分请求为云客分配的管理员id，个别接口需要传员工的用户id |
| company | 企业代码 |
| timestamp | unix时间戳，精确到毫秒 例如 1530081688201（如果时间相差1分钟 会返回错误结果） |
| sign | 签名 MD5后转大写，计算方式 md5(签名key+company+partnerId+timestamp).toUpper |
Header示例: 签名key为 sign-key-baidu
请求需要传入的header参数：
timestamp: 1530081688201
partnerId: p123456
company: baidu
sign = md5(sign-key-baidubaidup1234561530081688201).toUpper() = A5869E8A67393190E81197CBA43A8782
文档更新日志
V2021年8月18日：
新增文档更新日志
新增获取公司所有微信好友或微信群接口（/open/wechat/getAllFriends）
优化根据消息id获取语音文件消息补充链接接口的响应（/open/wechat/getRecordsByMsgId）
苏ICP备17060761号