SDK 文档

服务端 API

REST API 接口列表

最近更新时间:2020-10-28 10:19:55

以下视频将帮助您快速了解即时通信 IM 有哪些 REST API 接口:

帐号管理

功能说明 接口
导入单个帐号 v4/im_open_login_svc/account_import
导入多个帐号 v4/im_open_login_svc/multiaccount_import
删除帐号 v4/im_open_login_svc/account_delete
查询帐号 v4/im_open_login_svc/account_check
失效帐号登录态 v4/im_open_login_svc/kick
查询帐号在线状态 v4/openim/querystate

单聊消息

功能说明 接口
单发单聊消息 v4/openim/sendmsg
批量发单聊消息 v4/openim/batchsendmsg
导入单聊消息 v4/openim/importmsg
查询单聊消息 v4/openim/admin_getroammsg
撤回单聊消息 v4/openim/admin_msgwithdraw

全员推送

功能说明 接口
全员推送 v4/all_member_push/im_push
设置应用属性名称 v4/all_member_push/im_set_attr_name
获取应用属性名称 v4/all_member_push/im_get_attr_name
获取用户属性 v4/all_member_push/im_get_attr
设置用户属性 v4/all_member_push/im_set_attr
删除用户属性 v4/all_member_push/im_remove_attr
获取用户标签 v4/all_member_push/im_get_tag
添加用户标签 v4/all_member_push/im_add_tag
删除用户标签 v4/all_member_push/im_remove_tag
删除用户所有标签 v4/all_member_push/im_remove_all_tags

资料管理

功能说明 接口
设置资料 v4/profile/portrait_set
拉取资料 v4/profile/portrait_get

关系链管理

功能说明 接口
添加好友 v4/sns/friend_add
导入好友 v4/sns/friend_import
更新好友 v4/sns/friend_update
删除好友 v4/sns/friend_delete
删除所有好友 v4/sns/friend_delete_all
校验好友 v4/sns/friend_check
拉取好友 v4/sns/friend_get
拉取指定好友 v4/sns/friend_get_list
添加黑名单 v4/sns/black_list_add
删除黑名单 v4/sns/black_list_delete
拉取黑名单 v4/sns/black_list_get
校验黑名单 v4/sns/black_list_check
添加分组 v4/sns/group_add
删除分组 v4/sns/group_delete

群组管理

功能说明 接口
创建群组 v4/group_open_http_svc/create_group
获取群详细资料 v4/group_open_http_svc/get_group_info
获取群成员详细资料 v4/group_open_http_svc/get_group_member_info
修改群基础资料 v4/group_open_http_svc/modify_group_base_info
增加群成员 v4/group_open_http_svc/add_group_member
删除群成员 v4/group_open_http_svc/delete_group_member
修改群成员资料 v4/group_open_http_svc/modify_group_member_info
解散群组 v4/group_open_http_svc/destroy_group
获取用户所加入的群组 v4/group_open_http_svc/get_joined_group_list
查询用户在群组中的身份 v4/group_open_http_svc/get_role_in_group
批量禁言和取消禁言 v4/group_open_http_svc/forbid_send_msg
获取被禁言群成员列表 v4/group_open_http_svc/get_group_shutted_uin
在群组中发送普通消息 v4/group_open_http_svc/send_group_msg
在群组中发送系统通知 v4/group_open_http_svc/send_group_system_notification
撤回群消息 v4/group_open_http_svc/group_msg_recall
转让群主 v4/group_open_http_svc/change_group_owner
导入群基础资料 v4/group_open_http_svc/import_group
导入群消息 v4/group_open_http_svc/import_group_msg
导入群成员 v4/group_open_http_svc/import_group_member
设置成员未读消息计数 v4/group_open_http_svc/set_unread_msg_num
删除指定用户发送的消息 v4/group_open_http_svc/delete_group_msg_by_sender
拉取群历史消息 v4/group_open_http_svc/group_msg_get_simple
获取直播群在线人数 v4/group_open_http_svc/get_online_member_num

全局禁言管理

功能说明 接口
设置全局禁言 v4/openconfigsvr/setnospeaking
查询全局禁言 v4/openconfigsvr/getnospeaking

运营管理

功能说明 接口
拉取运营数据 v4/openconfigsvr/getappinfo
下载消息记录 v4/open_msg_svc/get_history
获取服务器 IP 地址 v4/ConfigSvc/GetIPList
目录