服务与方法
本页列出 Python SDK 的全部服务和方法,以及每个方法对应的 REST 接口。参数和返回值的含义见“文档”一列链接的 REST API 文档,SDK 的参数与 REST 接口的字段同名,对应规则见命名规则。
DRClient 和 AsyncDRClient 的服务和方法完全相同,异步客户端的方法是协程,遍历方法返回异步迭代器。
表中各列的含义:
- REST 接口:路径省略了前缀
/{org_name}/{app_name}; - 接口名:错误的
op、client.stats()的键、钩子收到的RequestInfo.op和测试辅助FakeOpenAPI中使用的名字,与方法名不完全相同(如users.list_mutes的接口名是users.mutes); - 自动重试:网络错误、超时、
5xx时 SDK 是否自动重试,类别的含义见重试与幂等。被限流时的等待重发对所有方法都有效,见限流; - 遍历方法(
iter、iter_xxx)逐页调用对应的列表接口,见自动翻页;带_all后缀的方法按上限拆分后逐批调用批量接口,见超过上限的批量。
用户 client.users
| 方法 | REST 接口 | 接口名 | 自动重试 | 文档 |
|---|---|---|---|---|
list_muted | GET /mutes | users.list_muted | 查询 | 查询被禁言的用户列表 |
iter_muted | 逐页调用 GET /mutes | users.list_muted | 查询 | 查询被禁言的用户列表 |
create | POST /users | users.create | 唯一创建 | 创建用户 |
list | GET /users | users.list | 查询 | 查询用户列表 |
iter | 逐页调用 GET /users | users.list | 查询 | 查询用户列表 |
batch_create | POST /users/batch | users.batch_create | 唯一创建 | 批量创建用户 |
batch_create_all | 分批调用 POST /users/batch | users.batch_create | 唯一创建 | 批量创建用户 |
lookup | POST /users/lookup | users.lookup | 查询 | 按用户名批量查询 |
get | GET /users/{username} | users.get | 查询 | 查询用户 |
update | PATCH /users/{username} | users.update | 幂等 | 修改用户资料 |
delete | DELETE /users/{username} | users.delete | 幂等 | 删除用户 |
disable | POST /users/{username}/disable | users.disable | 幂等 | 封禁用户 |
enable | POST /users/{username}/enable | users.enable | 幂等 | 解封用户 |
issue_login_ticket | POST /users/{username}/login-tickets | users.issue_login_ticket | 幂等 | 签发登录凭证 |
list_mutes | GET /users/{username}/mutes | users.mutes | 查询 | 查询用户的禁言 |
mute | PUT /users/{username}/mutes/{scope} | users.mute | 幂等 | 设置禁言 |
unmute | DELETE /users/{username}/mutes/{scope} | users.unmute | 幂等 | 解除禁言 |
set_password | PUT /users/{username}/password | users.set_password | 不重试 | 设置密码 |
list_sessions | GET /users/{username}/sessions | users.sessions | 查询 | 查询登录设备 |
kick_all | DELETE /users/{username}/sessions | users.kick_all | 不重试 | 踢掉全部设备 |
kick | DELETE /users/{username}/sessions/{session_id} | users.kick | 幂等 | 踢掉单台设备 |
好友 client.friends
| 方法 | REST 接口 | 接口名 | 自动重试 | 文档 |
|---|---|---|---|---|
list_requests | GET /users/{username}/friend-requests | friends.requests | 查询 | 查询好友申请 |
iter_requests | 逐页调用 GET /users/{username}/friend-requests | friends.requests | 查询 | 查询好友申请 |
get_settings | GET /users/{username}/friend-settings | friends.settings | 查询 | 查询加好友方式 |
set_settings | PUT /users/{username}/friend-settings | friends.set_settings | 幂等 | 设置加好友方式 |
list | GET /users/{username}/friends | friends.list | 查询 | 查询好友列表 |
iter | 逐页调用 GET /users/{username}/friends | friends.list | 查询 | 查询好友列表 |
delete_all | DELETE /users/{username}/friends | friends.delete_all | 幂等 | 删除全部好友 |
batch_add | POST /users/{username}/friends/batch | friends.batch_add | 幂等 | 批量添加好友 |
batch_add_all | 分批调用 POST /users/{username}/friends/batch | friends.batch_add | 幂等 | 批量添加好友 |
batch_delete | POST /users/{username}/friends/batch-delete | friends.batch_delete | 幂等 | 批量删除好友 |
check | POST /users/{username}/friends/check | friends.check | 查询 | 检查好友关系 |
get | GET /users/{username}/friends/{friend} | friends.get | 查询 | 查询单个好友 |
add | PUT /users/{username}/friends/{friend} | friends.add | 幂等 | 添加好友 |
update | PATCH /users/{username}/friends/{friend} | friends.update | 幂等 | 修改好友备注和自定义属性 |
delete | DELETE /users/{username}/friends/{friend} | friends.delete | 幂等 | 删除好友 |
黑名单 client.blacklist
| 方法 | REST 接口 | 接口名 | 自动重试 | 文档 |
|---|---|---|---|---|
list | GET /users/{username}/blacklist | blacklist.list | 查询 | 查询黑名单 |
iter | 逐页调用 GET /users/{username}/blacklist | blacklist.list | 查询 | 查询黑名单 |
batch_add | POST /users/{username}/blacklist/batch | blacklist.batch_add | 幂等 | 批量拉黑 |
batch_remove | POST /users/{username}/blacklist/batch-delete | blacklist.batch_remove | 幂等 | 批量移出黑名单 |
add | PUT /users/{username}/blacklist/{target} | blacklist.add | 幂等 | 拉黑用户 |
remove | DELETE /users/{username}/blacklist/{target} | blacklist.remove | 幂等 | 移出黑名单 |
群组 client.groups
| 方法 | REST 接口 | 接口名 | 自动重试 | 文档 |
|---|---|---|---|---|
create | POST /groups | groups.create | 不重试 | 创建群 |
list | GET /groups | groups.list | 查询 | 查询群列表 |
iter | 逐页调用 GET /groups | groups.list | 查询 | 查询群列表 |
get | GET /groups/{group_id} | groups.get | 查询 | 查询群信息 |
update | PATCH /groups/{group_id} | groups.update | 幂等 | 修改群资料和设置 |
delete | DELETE /groups/{group_id} | groups.delete | 幂等 | 解散群 |
list_blacklist | GET /groups/{group_id}/blacklist | groups.blacklist | 查询 | 查询群黑名单 |
iter_blacklist | 逐页调用 GET /groups/{group_id}/blacklist | groups.blacklist | 查询 | 查询群黑名单 |
add_to_blacklist | PUT /groups/{group_id}/blacklist/{username} | groups.add_to_blacklist | 幂等 | 将用户加入群黑名单 |
remove_from_blacklist | DELETE /groups/{group_id}/blacklist/{username} | groups.remove_from_blacklist | 幂等 | 将用户移出群黑名单 |
disable | POST /groups/{group_id}/disable | groups.disable | 幂等 | 封禁群 |
enable | POST /groups/{group_id}/enable | groups.enable | 幂等 | 解封群 |
list_members | GET /groups/{group_id}/members | groups.members | 查询 | 查询群成员列表 |
iter_members | 逐页调用 GET /groups/{group_id}/members | groups.members | 查询 | 查询群成员列表 |
add_members | POST /groups/{group_id}/members/batch | groups.add_members | 幂等 | 批量添加群成员 |
remove_members | POST /groups/{group_id}/members/batch-delete | groups.remove_members | 幂等 | 批量移出群成员 |
get_member | GET /groups/{group_id}/members/{username} | groups.member | 查询 | 查询群成员 |
update_member | PATCH /groups/{group_id}/members/{username} | groups.update_member | 幂等 | 修改群成员资料 |
mute_member | PUT /groups/{group_id}/members/{username}/mute | groups.mute_member | 幂等 | 禁言群成员 |
unmute_member | DELETE /groups/{group_id}/members/{username}/mute | groups.unmute_member | 幂等 | 解除群成员禁言 |
set_role | PUT /groups/{group_id}/members/{username}/role | groups.set_role | 幂等 | 设置群成员角色 |
set_mute_all | PUT /groups/{group_id}/mute-all(on=True)DELETE /groups/{group_id}/mute-all(on=False) | groups.mute_allgroups.unmute_all | 幂等 | 开启全员禁言 关闭全员禁言 |
transfer_owner | PUT /groups/{group_id}/owner | groups.transfer_owner | 幂等 | 转让群主 |
list_requests | GET /groups/{group_id}/requests | groups.requests | 查询 | 查询入群申请和邀请 |
iter_requests | 逐页调用 GET /groups/{group_id}/requests | groups.requests | 查询 | 查询入群申请和邀请 |
get_invite_settings | GET /users/{username}/group-settings | groups.invite_settings | 查询 | 查询用户的入群设置 |
set_invite_settings | PUT /users/{username}/group-settings | groups.set_invite_settings | 幂等 | 修改用户的入群设置 |
list_of_user | GET /users/{username}/groups | groups.of_user | 查询 | 查询用户加入的群 |
iter_of_user | 逐页调用 GET /users/{username}/groups | groups.of_user | 查询 | 查询用户加入的群 |
消息 client.messages
| 方法 | REST 接口 | 接口名 | 自动重试 | 文档 |
|---|---|---|---|---|
send | POST /messages | messages.send | 幂等键;online_only=True 时不重试 | 发送单条消息 |
export | GET /messages | messages.export | 查询 | 导出应用的消息 |
iter_export | 逐页调用 GET /messages | messages.export | 查询 | 导出应用的消息 |
batch_send | POST /messages/batch | messages.batch_send | 幂等键 | 批量发送消息 |
batch_send_all | 分批调用 POST /messages/batch | messages.batch_send | 幂等键 | 批量发送消息 |
batch_recall | POST /messages/batch-recall | messages.batch_recall | 幂等 | 批量撤回消息 |
get | GET /messages/{message_id} | messages.get | 查询 | 查询单条消息 |
edit | PATCH /messages/{message_id} | messages.edit | 幂等 | 编辑消息 |
pin | PUT /messages/{message_id}/pin | messages.pin | 幂等 | 置顶消息 |
unpin | DELETE /messages/{message_id}/pin | messages.unpin | 幂等 | 取消置顶消息 |
recall | POST /messages/{message_id}/recall | messages.recall | 幂等 | 撤回消息 |
list_sent_by | GET /users/{username}/sent-messages | messages.sent_by | 查询 | 查询用户发出的消息 |
iter_sent_by | 逐页调用 GET /users/{username}/sent-messages | messages.sent_by | 查询 | 查询用户发出的消息 |
会话 client.conversations
| 方法 | REST 接口 | 接口名 | 自动重试 | 文档 |
|---|---|---|---|---|
get | GET /conversations/{conversation_id} | conversations.get | 查询 | 查询会话信息 |
list_messages | GET /conversations/{conversation_id}/messages | conversations.messages | 查询 | 拉取会话的历史消息 |
iter_messages | 逐页调用 GET /conversations/{conversation_id}/messages | conversations.messages | 查询 | 拉取会话的历史消息 |
list_pins | GET /conversations/{conversation_id}/pins | conversations.pins | 查询 | 查询会话中的置顶消息 |
iter_pins | 逐页调用 GET /conversations/{conversation_id}/pins | conversations.pins | 查询 | 查询会话中的置顶消息 |
get_single | GET /single-conversations/{username}/{peer} | conversations.single | 查询 | 查询两个用户之间的单聊会话 |
list_of_user | GET /users/{username}/conversations | conversations.of_user | 查询 | 查询用户的会话列表 |
iter_of_user | 逐页调用 GET /users/{username}/conversations | conversations.of_user | 查询 | 查询用户的会话列表 |
mark_all_read | POST /users/{username}/conversations/read-all | conversations.mark_all_read | 幂等 | 全部标记已读 |
get_state_of_user | GET /users/{username}/conversations/{conversation_id} | conversations.state_of_user | 查询 | 查询用户的单个会话 |
delete | DELETE /users/{username}/conversations/{conversation_id} | conversations.delete | 幂等 | 删除会话 |
clear | POST /users/{username}/conversations/{conversation_id}/clear | conversations.clear | 幂等 | 清空聊天记录 |
delete_messages | POST /users/{username}/conversations/{conversation_id}/messages/delete | conversations.delete_messages | 幂等 | 删除消息 |
mark_read | POST /users/{username}/conversations/{conversation_id}/read | conversations.mark_read | 幂等 | 标记会话已读 |
unread_count | GET /users/{username}/unread-count | conversations.unread_count | 查询 | 查询用户的未读总数 |
文件 client.media
| 方法 | REST 接口 | 接口名 | 自动重试 | 文档 |
|---|---|---|---|---|
upload | POST /media/uploads、上传内容、POST /media/uploads/{file_id}/complete | media.create_upload 等 | 见上传文件 | 文件上传 |
resume_upload | GET /media/uploads/{file_id}/parts、补传分片、POST /media/uploads/{file_id}/complete | media.uploaded_parts 等 | 幂等 | 文件上传 |
download | POST /media/download-urls,再从下载地址读取 | media.download_urls | 查询 | 换取下载地址 |
get_download_urls | POST /media/download-urls | media.download_urls | 查询 | 换取下载地址 |
get_file | GET /media/files/{file_id} | media.file | 查询 | 查询文件 |
delete_file | DELETE /media/files/{file_id} | media.delete_file | 幂等 | 删除文件 |
list_group_files | GET /media/groups/{group_id}/files | media.group_files | 查询 | 查询群文件列表 |
iter_group_files | 逐页调用 GET /media/groups/{group_id}/files | media.group_files | 查询 | 查询群文件列表 |
create_upload | POST /media/uploads | media.create_upload | 不重试 | 创建上传 |
cancel_upload | DELETE /media/uploads/{file_id} | media.cancel_upload | 幂等 | 取消上传 |
complete_upload | POST /media/uploads/{file_id}/complete | media.complete_upload | 幂等 | 完成上传 |
get_part_urls | POST /media/uploads/{file_id}/parts | media.part_urls | 查询 | 索取分片上传地址 |
list_uploaded_parts | GET /media/uploads/{file_id}/parts | media.uploaded_parts | 查询 | 查询已上传的分片 |
usage | GET /media/usage | media.usage | 查询 | 查询存储用量 |
推送设置 client.push
| 方法 | REST 接口 | 接口名 | 自动重试 | 文档 |
|---|---|---|---|---|
list_devices | GET /users/{username}/push-devices | push.devices | 查询 | 查询推送设备 |
unbind_device | DELETE /users/{username}/push-devices/{session_id} | push.unbind_device | 幂等 | 解绑推送设备 |
get_settings | GET /users/{username}/push-settings | push.settings | 查询 | 查询推送设置 |
update_settings | PATCH /users/{username}/push-settings | push.update_settings | 幂等 | 修改推送设置 |
list_mutes | GET /users/{username}/push-settings/conversations | push.mutes | 查询 | 查询会话免打扰 |
iter_mutes | 逐页调用 GET /users/{username}/push-settings/conversations | push.mutes | 查询 | 查询会话免打扰 |
mute_group | PUT /users/{username}/push-settings/conversations/group/{group_id} | push.mute_group | 幂等 | 设置会话免打扰 |
unmute_group | DELETE /users/{username}/push-settings/conversations/group/{group_id} | push.unmute_group | 幂等 | 取消会话免打扰 |
mute_single | PUT /users/{username}/push-settings/conversations/single/{peer} | push.mute_single | 幂等 | 设置会话免打扰 |
unmute_single | DELETE /users/{username}/push-settings/conversations/single/{peer} | push.unmute_single | 幂等 | 取消会话免打扰 |
聊天室 client.chatrooms
| 方法 | REST 接口 | 接口名 | 自动重试 | 文档 |
|---|---|---|---|---|
create | POST /chatrooms | chatrooms.create | 不重试 | 创建聊天室 |
list | GET /chatrooms | chatrooms.list | 查询 | 查询聊天室列表 |
iter | 逐页调用 GET /chatrooms | chatrooms.list | 查询 | 查询聊天室列表 |
online_counts | POST /chatrooms/online-counts | chatrooms.online_counts | 查询 | 批量查询在线人数 |
get | GET /chatrooms/{room_id} | chatrooms.get | 查询 | 查询聊天室信息 |
update | PATCH /chatrooms/{room_id} | chatrooms.update | 幂等 | 修改聊天室资料 |
delete | DELETE /chatrooms/{room_id} | chatrooms.delete | 幂等 | 解散聊天室 |
set_admin | PUT /chatrooms/{room_id}/admins/{username} | chatrooms.set_admin | 幂等 | 设置管理员 |
remove_admin | DELETE /chatrooms/{room_id}/admins/{username} | chatrooms.remove_admin | 幂等 | 取消管理员 |
list_allowlist | GET /chatrooms/{room_id}/allowlist | chatrooms.allowlist | 查询 | 查询白名单 |
iter_allowlist | 逐页调用 GET /chatrooms/{room_id}/allowlist | chatrooms.allowlist | 查询 | 查询白名单 |
add_to_allowlist | POST /chatrooms/{room_id}/allowlist | chatrooms.add_to_allowlist | 幂等 | 加入白名单 |
remove_from_allowlist | POST /chatrooms/{room_id}/allowlist/batch-delete | chatrooms.remove_from_allowlist | 幂等 | 移出白名单 |
get_attributes | GET /chatrooms/{room_id}/attributes | chatrooms.attributes | 查询 | 查询聊天室属性 |
set_attributes | PUT /chatrooms/{room_id}/attributes | chatrooms.set_attributes | 幂等 | 设置聊天室属性 |
remove_attributes | POST /chatrooms/{room_id}/attributes/batch-delete | chatrooms.remove_attributes | 幂等 | 删除聊天室属性 |
list_bans | GET /chatrooms/{room_id}/bans | chatrooms.bans | 查询 | 查询封禁名单 |
iter_bans | 逐页调用 GET /chatrooms/{room_id}/bans | chatrooms.bans | 查询 | 查询封禁名单 |
ban | POST /chatrooms/{room_id}/bans | chatrooms.ban | 幂等 | 封禁用户 |
unban | POST /chatrooms/{room_id}/bans/batch-delete | chatrooms.unban | 幂等 | 解除封禁 |
disable | POST /chatrooms/{room_id}/disable | chatrooms.disable | 幂等 | 封禁聊天室 |
enable | POST /chatrooms/{room_id}/enable | chatrooms.enable | 幂等 | 解封聊天室 |
list_members | GET /chatrooms/{room_id}/members | chatrooms.members | 查询 | 查询聊天室成员列表 |
iter_members | 逐页调用 GET /chatrooms/{room_id}/members | chatrooms.members | 查询 | 查询聊天室成员列表 |
kick | POST /chatrooms/{room_id}/members/batch-delete | chatrooms.kick | 幂等 | 移出聊天室成员 |
get_member | GET /chatrooms/{room_id}/members/{username} | chatrooms.member | 查询 | 查询用户是否在聊天室里 |
send | POST /chatrooms/{room_id}/messages | chatrooms.send | 幂等键;priority="low" 时不重试 | 发送聊天室消息 |
list_recent_messages | GET /chatrooms/{room_id}/messages | chatrooms.recent_messages | 查询 | 查询最近的消息 |
recall | POST /chatrooms/{room_id}/messages/{message_id}/recall | chatrooms.recall | 幂等 | 撤回聊天室消息 |
set_mute_all | PUT /chatrooms/{room_id}/mute-all(on=True)DELETE /chatrooms/{room_id}/mute-all(on=False) | chatrooms.mute_allchatrooms.unmute_all | 幂等 | 开启全员禁言 关闭全员禁言 |
list_mutes | GET /chatrooms/{room_id}/mutes | chatrooms.mutes | 查询 | 查询禁言名单 |
iter_mutes | 逐页调用 GET /chatrooms/{room_id}/mutes | chatrooms.mutes | 查询 | 查询禁言名单 |
mute | POST /chatrooms/{room_id}/mutes | chatrooms.mute | 幂等 | 禁言用户 |
unmute | POST /chatrooms/{room_id}/mutes/batch-delete | chatrooms.unmute | 幂等 | 解除禁言 |
transfer_owner | PUT /chatrooms/{room_id}/owner | chatrooms.transfer_owner | 幂等 | 转让所有者 |
内容安全 client.moderation
| 方法 | REST 接口 | 接口名 | 自动重试 | 文档 |
|---|---|---|---|---|
process_pending | GET /moderation/items、GET /moderation/items/{item_id}/content、POST /moderation/items/{item_id}/decide | moderation.items 等 | 带 version 作出结论,可以重试 | 审核记录 |
get_config | GET /moderation/config | moderation.config | 查询 | 查询审核配置 |
update_config | PATCH /moderation/config | moderation.update_config | 幂等 | 修改审核配置 |
list_items | GET /moderation/items | moderation.items | 查询 | 查询审核记录列表 |
iter_items | 逐页调用 GET /moderation/items | moderation.items | 查询 | 查询审核记录列表 |
batch_decide | POST /moderation/items/batch-decide | moderation.batch_decide | 幂等 | 批量作出结论 |
get_item | GET /moderation/items/{item_id} | moderation.item | 查询 | 查询审核记录 |
get_item_content | GET /moderation/items/{item_id}/content | moderation.item_content | 查询 | 读取审核记录的内容 |
decide | POST /moderation/items/{item_id}/decide | moderation.decide | 幂等;带 actions 不带 version 时不重试 | 作出结论 |
escalate | POST /moderation/items/{item_id}/escalate | moderation.escalate | 不重试 | 转交平台 |
list_platform_actions | GET /moderation/platform-actions | moderation.platform_actions | 查询 | 查询平台的处置 |
iter_platform_actions | 逐页调用 GET /moderation/platform-actions | moderation.platform_actions | 查询 | 查询平台的处置 |
report | POST /moderation/reports | moderation.report | 幂等 | 代用户举报 |
stats | GET /moderation/stats | moderation.stats | 查询 | 查询统计 |
check_text | POST /moderation/text-check | moderation.check_text | 查询 | 检查文本 |
list_violations | GET /moderation/users/{username}/violations | moderation.violations | 查询 | 查询用户的违规 |
iter_violations | 逐页调用 GET /moderation/users/{username}/violations | moderation.violations | 查询 | 查询用户的违规 |
clear_violations | DELETE /moderation/users/{username}/violations | moderation.clear_violations | 幂等 | 清除用户的违规 |
list_word_lists | GET /moderation/word-lists | moderation.word_lists | 查询 | 查询词库列表 |
create_word_list | POST /moderation/word-lists | moderation.create_word_list | 不重试 | 创建词库 |
get_word_list | GET /moderation/word-lists/{list_id} | moderation.word_list | 查询 | 查询词库 |
update_word_list | PATCH /moderation/word-lists/{list_id} | moderation.update_word_list | 幂等 | 修改词库 |
delete_word_list | DELETE /moderation/word-lists/{list_id} | moderation.delete_word_list | 幂等 | 删除词库 |
list_words | GET /moderation/word-lists/{list_id}/words | moderation.words | 查询 | 查询词条 |
iter_words | 逐页调用 GET /moderation/word-lists/{list_id}/words | moderation.words | 查询 | 查询词条 |
add_words | POST /moderation/word-lists/{list_id}/words/batch | moderation.add_words | 幂等 | 添加词条 |
remove_words | POST /moderation/word-lists/{list_id}/words/batch-delete | moderation.remove_words | 幂等 | 删除词条 |
process_pending(handle, *, scene=UNSET, limit=20, stop_on_error=False) 逐条处理待审核的记录(状态为 pending、auto_violation):读取记录的内容,调用 handle(item, content),按它返回的 Decision 作出结论,返回 None 时跳过;返回作出结论的条数。作出结论时带上读到的 version,所以可以安全重试,已被别人处理(version_conflict)的记录跳过;handle 出错时记日志并继续,stop_on_error=True 时抛出。异步客户端中 handle 可以是协程函数。
from deeprespond_im import Decision, DRClient
from deeprespond_im.types import ItemContent, ModerationItem
def review(item: ModerationItem, content: ItemContent) -> Decision | None:
if item.scene != "message":
return None # 跳过,留给人工
return Decision("no_violation", note="自动复审:无违规")
def run_review(client: DRClient) -> None:
decided = client.moderation.process_pending(review, scene="message")
print("处理了", decided, "条")音视频通话 client.calls
| 方法 | REST 接口 | 接口名 | 自动重试 | 文档 |
|---|---|---|---|---|
list | GET /calls | calls.list | 查询 | 查询通话列表 |
iter | 逐页调用 GET /calls | calls.list | 查询 | 查询通话列表 |
get | GET /calls/{call_id} | calls.get | 查询 | 查询通话详情 |
end | POST /calls/{call_id}/end | calls.end | 幂等 | 结束通话 |
remove_member | POST /calls/{call_id}/members/{username}/remove | calls.remove_member | 幂等 | 把成员移出通话 |
stats | GET /rtc/stats | calls.stats | 查询 | 查询通话统计 |
get_active_call | GET /users/{username}/calls/active | calls.active_of | 查询 | 查询用户正在进行的通话 |
在线状态 client.presence
| 方法 | REST 接口 | 接口名 | 自动重试 | 文档 |
|---|---|---|---|---|
query | POST /presence/query | presence.query | 查询 | 批量查询在线状态 |
get | GET /users/{username}/presence | presence.get | 查询 | 查询用户的在线状态 |
独立 RTC 频道:client.channels
服务只管理频道,不替用户加入媒体。参数及响应见频道 REST API。接口地址省略通用应用前缀。
| 方法 | REST 接口 | 参数说明 |
|---|---|---|
create | PUT /rtc/channels/{channel_id} | 路径参数在前;查询 / 请求字段为关键字参数 |
list | GET /rtc/channels | 路径参数在前;查询 / 请求字段为关键字参数 |
get | GET /rtc/channels/{channel_id} | 路径参数在前;查询 / 请求字段为关键字参数 |
update | PATCH /rtc/channels/{channel_id} | 路径参数在前;查询 / 请求字段为关键字参数 |
close | POST /rtc/channels/{channel_id}/close | 路径参数在前;查询 / 请求字段为关键字参数 |
issue_tickets | POST /rtc/channels/{channel_id}/tickets | 路径参数在前;查询 / 请求字段为关键字参数 |
revoke_tickets | POST /rtc/channels/{channel_id}/tickets/revoke | 路径参数在前;查询 / 请求字段为关键字参数 |
sessions | GET /rtc/channels/{channel_id}/sessions | 路径参数在前;查询 / 请求字段为关键字参数 |
remove_member | POST /rtc/channels/{channel_id}/members/{username}/remove | 路径参数在前;查询 / 请求字段为关键字参数 |
bans | GET /rtc/channels/{channel_id}/bans | 路径参数在前;查询 / 请求字段为关键字参数 |
get_ban | GET /rtc/channels/{channel_id}/bans/{username} | 路径参数在前;查询 / 请求字段为关键字参数 |
ban | PUT /rtc/channels/{channel_id}/bans/{username} | 路径参数在前;查询 / 请求字段为关键字参数 |
unban | DELETE /rtc/channels/{channel_id}/bans/{username} | 路径参数在前;查询 / 请求字段为关键字参数 |
stats | GET /rtc/channel-stats | 路径参数在前;查询 / 请求字段为关键字参数 |
usage_adjustments | GET /rtc/channel-usage-adjustments | 路径参数在前;查询 / 请求字段为关键字参数 |
结果保留频道、会话、票据、封禁、统计和更正的具体模型及原始数据。创建包装的 created 来自 201,关闭 / 移出包装的 pending 来自 202;不是 HTTP 响应新增的同名字段。末页 next_cursor、无封禁 ban 及可清除期限保留 null。
这些频道分页返回具体页对象;使用 next_cursor 手动继续,不照搬原 Calls 的 All / iter。expires_at 保留“不传 / null 清除 / 值设置”三态。签票据不自动重试,移出和撤票使用固定 operation_id。
