You need to enable JavaScript to run this app.
导航

服务端 OpenAPI

最近更新时间2024.01.24 18:07:28

首次发布时间2023.07.27 20:35:41

说明

  • 即时通讯 IM 目前支持根据业务需求选择数据存储在国内或海外,你可以前往控制台创建应用。详情参看应用管理

2024-01-24

新增接口

  • 新增 获取 Token GetAppToken,你可以指定你所属的 AppId,UserId 和 Token 过期时间来生成 Token进行鉴权,以进行通讯。

2023-12-28

新增功能

  • 新增用户注册功能,你可以调用接口进行用户注册和注销,后续进行广播或资料更新。

    • 新增 RegisterUsers,你可以使用此接口对用户进行注册。
    • 新增 UnRegisterUsers,你可以使用此接口对已注册的用户进行注销。
  • 新增全员广播功能,你可以调用接口管理广播用户,对符合筛选标签的用户进行全员广播。

    • 新增 UserBroadcast,你可以使用此接口对符合标签的用户进行全员广播。
    • 新增 BatchUpdateUserTags,你可以使用此接口对已注册的广播用户进行标签更新。
  • 新增用户资料功能,你可以调用接口对用户资料进行查询和更新。

    • 新增 BatchGetUser,你可以使用此接口对已注册的用户进行资料查询。
    • 新增 BatchUpdateUser,你可以调用此接口对用户资料进行更新。
  • 新增标记会话功能,你可以对会话进行标记,并对会话标记进行查询。

接口变更

2023-12-22

新增回调

接口变更

  • GetConversationMessages
    • Result.Messages 中增加 Property结构,增加返回消息修改后的消息属性。
  • GetMessages
    • Result.Messages 中增加 Property结构,增加返回消息修改后的消息属性。

2023-12-15

回调变更

2023-10-30

新增接口

接口变更

  • ScanConversationParticipantList
    • Result 结构中 Participants 参数增加 AvatarUrl,新增返回群成员头像。
  • BatchGetWhitelistParticipant
    • Result 结构中 Participants 参数增加 NickNameExtAvatarUrl,新增返回白名单成员资料。
  • BatchGetBlockParticipants
    • Result 结构中 Participants 参数增加 NickNameExtAvatarUrl,新增返回禁言/拉黑成员资料。
  • ListFriend
    • Result 结构中 FriendInfo 参数增加 Alias,返回好友备注。
  • GetBlackList
    • Result 结构中 FriendInfo 参数增加 FriendUserInfo,若黑名单用户为查询用户好友,则返回该好友详细信息。

2023-10-12

新增回调

  • 新增 AfterSendMessage,消息发送成功且存入数据库后触发此回调。

2023-09-25

新增功能

新增黑名单管理功能。

  • 新增 AddBlackList,你可以使用此接口添加用户至黑名单。
  • 新增 RemoveBlackList,你可以使用此接口将用户移出黑名单。
  • 新增 UpdateBlackList,你可以使用此接口更新黑名单中用户的扩展信息。
  • 新增 GetBlackList,你可以使用此接口查询黑名单列表。
  • 新增 IsInBlackList,你可以使用此接口校验用户是否在黑名单中。

2023-08-25

新增功能

新增好友关系管理功能,你可以调用接口添加、删除好友,也可查询好友列表和校验好友关系。

  • 新增 AddFriend,你可以使用此接口添加好友。
  • 新增 DeleteFriend,你可以使用此接口删除好友。
  • 新增 ListFriend,你可以使用此接口查询指定用户的好友列表。
  • 新增 IsFriend,你可以使用此接口校验两个用户之间的好友关系。

2023-08-02

接口变更

  • CreateConversation
    • Result 结构中 ConversationInfo 参数增加 OtherUserId,群聊时为会话 ID,单聊时为另一个成员的 UserId
  • GetUserConversations
    • Result 结构中 ConversationInfo 参数增加 OtherUserId,群聊时为会话 ID,单聊时为另一个成员的 UserId

2023-07-28

新增回调

  • 新增 AfterPush,将客户端发送的消息在线推送后触发此回调。

2023-07-25

新增回调

2023-06-21

新增接口

接口优化

  • SendMessage 新增 Priority 字段,支持设置消息优先级。

2023-05-25

新增接口

接口变更

  • CreateConversation
    • Body 结构中 ConversationCoreInfo.ConversationType 参数增加枚举值 100,表示直播群类型。
    • Result 结构中 ConversationInfo 参数增加 OnlineCount,表示直播群在线人数。
  • BatchGetConversations
    • Body 结构中 DataType 参数增加枚举值 2,表示获得用户创建的直播群。
    • Result 结构中 ConversationInfo 参数增加 OnlineCount,表示直播群在线人数。
  • ScanConversationParticipantList
    • 若只查询群成员的 UserId,单次最多可查询人数变为 50;若需查询群成员详细信息,单次最多可查询人数变为 20。
    • Body 结构中新增 ScanOnlineParticipant 参数,判断是否获取直播群在线成员列表。
  • ScanConversationParticipantList
    • Body 结构中 DeleteType 参数,直播群下只允许传 0

新增回调

回调变更

  • BeforeSendMessage
    • EventData 结构中 MessageBody.ConversationType 参数增加枚举值 100,表示直播群类型。
  • BeforeUpdateConversation
    • EventData 结构中 ConversationType 参数增加枚举值 100,表示直播群类型。