Eyun 开发者文档

Appearance

常用 ID 说明 ​

调用接口时，不确定某个 ID 填什么、从哪里取，就在下表查对应字段。第一次使用先按快速开始完成收发测试，用到哪个 ID，再查哪个。

标识一览 ​

标识是什么从哪来用在哪类型
appid实例 ID，一个实例对应一个登录的企微账号首次调获取二维码不传 appid，响应 data.appid 返回所有业务接口的 body；之后每次取码都要带原 appidstring，形如 we_xxxxxxxxxxxxxxx
uuid本次扫码会话的票据获取二维码响应 data.uuid检测二维码、提交验证码；二维码过期即失效string
uin用户唯一 id当前账号：获取个人信息响应 data.uin；推送里发送方的 uin 在 fromUserId给自己发消息时作 conversationId；重新扫码后确认登录的还是同一个账号int64
userId用户的 uin 在接口参数里的另一种叫法好友申请回调、通讯录同步或群成员，具体见取值来源单聊发送的 conversationId；联系人和群管理接口的用户参数int64
vid通讯录成员的联系人 id，等于该成员的 uin同步通讯录 ID 列表返回的 nodeList[] 里成员节点（type 为 1）的 vid获取用户信息详情按 vid / uin 列表查资料int64
roomId群会话 id获取我的客户群列表的 data.roomData.list[].roomId；也可复用回调里带出的 roomId除建群外几乎所有群接口；群聊发送的 conversationIdint64
conversationId发送接口的会话 id按会话取值：单聊传对方 userId，群聊传 roomId，给自己发传当前账号 uin所有发送接口；撤回消息时与发送时相同int64，必须是 JSON number
消息 id / serverMsgId消息服务端 id，同一账号内唯一；撤回时参数名叫 serverMsgId发送接口响应的 data.id，或回调推送报文里的 id撤回消息的 serverMsgId；消息层去重int64
X-Eyun-Event-Id稳定事件 ID，重试不变回调请求头推送层去重string
X-Eyun-Delivery本次尝试 ID，重试变化回调请求头定位推送记录string
X-Eyun-Instance-Id真实来源实例 ID回调请求头，测试事件不携带区分消息所属账号string
syncKey同步位置，递增回调推送报文、发送接口响应与同步消息响应里的 syncKey同步消息请求的 syncKey，首次可传 0int64

int64 标识不要当字符串

表里类型为 int64 的标识，发送时必须是 JSON number，不能传字符串；解析时不要经过浮点数。

最容易混淆的规则 ​

  • userId、uin、vid 是同一个 int64 数值的不同叫法。 不需要在这三个名字之间换算。
  • 单聊的 conversationId 是对方的 uin。 发送接口参数说明里写作「对方 userId」；推送里对方的 uin 在 fromUserId。
  • 群聊用 roomId，不是客户群列表里的 id。 列表项里更长的 id 是客户群记录 id，做群操作和发群消息一律用 roomId，见群操作调用流程。
  • 给自己发用当前账号的 uin。 用获取个人信息取得，不要硬编码；自聊伪房间的 roomId 不能作为发送目标，否则返回 -3020。
  • 去重分两层。 推送层用请求头 X-Eyun-Event-Id，消息层用 X-Eyun-Instance-Id 与消息 id（同一账号内唯一），见回调说明 · 回调地址要求。

userId 取值来源 ​

用途从哪里取
同意新客户好友申请回调的 content.uin，contentType 为 2357
删除联系人、修改联系人标签通讯录同步的成员 vid，或同步外部数据的 content.userInfo.uin
设置管理员、转让群主群成员的 uin，从群成员资料或群成员变动回调取得

下一步 ​