1V1 呼叫邀请场景 RTM 最佳实践
场景介绍
一对一呼叫中,主叫希望找到指定用户并发起通话;被叫需要先看到来电,再决定接听或拒绝。双方尚未进入同一个音视频频道时,先由 RTM 传递邀请信令,再由 RTC 建立音视频连接。
一次完整的呼叫按以下顺序执行:
- 双方登录 RTM,安装呼叫邀请模块,等待或发起呼叫。
- 主叫向指定用户发送邀请,被叫展示来电。
- 被叫接听,主叫确认;各端确认邀请已接受后,开始连接 RTC。
- RTC 媒体建立后,界面进入通话状态。
- 用户静音、恢复或挂断;结束后释放媒体资源,下一次呼叫创建新邀请。
被叫拒绝、主叫在等待期间取消,都是正常业务分支,双方不进入 RTC。无人应答、网络异常或媒体未建立时,则按相应截止时间结束等待并提示原因。
Web Demo 使用双页面演示语音通话,邀请设计也可用于视频呼叫。页面上的“呼叫 ID”是用户的 RTM 用户 ID;每次邀请另有唯一的 callId,用于关联本次信令与媒体。
| 能力 | 负责 | 不负责 |
|---|---|---|
| RTM | 呼叫、接听、拒绝、取消等点对点信令,消息发布结果和本端连接状态 | 音视频传输、媒体通话状态 |
| RTC | 加入频道、音视频传输、感知目标用户加入与离开 | 呼叫邀请信令 |
接入分层
呼叫功能由三层组成。Demo 中的呼叫邀请模块目前为 Web 版本,在 Java 上,你需要参照它的信令协议和状态设计实现中间一层(关键代码见 3. 实现指南),再完成 App 层的工作:
| 层 | 是什么 | 负责 |
|---|---|---|
| RTM SDK | 声网提供的实时消息 SDK | 点对点消息投递与送达结果、对方是否在线、本端连接状态与自动重连 |
呼叫邀请模块(invitation/) | 基于 RTM 点对点消息实现的呼叫逻辑。Demo 提供 Web 版本,Java 上参照其协议实现 | 定义呼叫信令协议,维护两端的呼叫状态,处理各阶段超时与邀请重试,记录失败原因 |
| App | 你的业务代码 | 安装与销毁模块、按状态渲染界面、按失败原因提示用户、接通后加入 RTC、媒体等待截止、占线策略 |
呼叫邀请模块不是 RTM SDK 的接口,而是一份 Web 参考实现。在 Java 上,需要参照其信令协议和状态设计自行实现。
术语
| 术语 | 含义 |
|---|---|
| 主叫 / 被叫 | 发起呼叫的一方 / 接收呼叫的一方,即 Caller / Callee |
| 邀请 | 一次呼叫在 RTM 侧的过程,从发起到出现结果为止。每次呼叫有唯一的 callId |
| 接听消息(accepted) | 被叫点击接听后发给主叫的消息 |
| 确认消息(ACK) | 主叫收到接听消息后回给被叫的消息,被叫据此确认接通 |
| 终态 | 邀请的最终结果:已接受、已拒绝、已取消或失败。进入终态后状态不再变化 |
核心规则
- 将呼叫邀请模块安装在 App 已登录的唯一 RTM client 上。登出前先销毁模块,重新登录后重新安装。
- App 自己的点对点消息监听必须忽略
CALL_KIT_系列customType。 - 以模块的状态驱动界面。
- 接受即邀请结束,之后只看 RTC。加入频道时设置媒体等待截止;挂断只离开 RTC 频道。
- 按失败原因提示用户。不在 App 层叠加自动重试。
1. 为什么 1V1 呼叫需要 RTM
呼叫发生在音视频通道建立之前,RTC 无法承担这一阶段的工作:
- 发起呼叫时,被叫还不在任何 RTC 频道中,无法通过 RTC 通知对方"有来电";
- 振铃、接听、拒绝、取消、无人应答都是业务动作,RTC 没有对应接口;
- 主叫需要区分"对方不在线""网络异常""对方没应答"并给出不同提示,RTC 无法提供这些信息;
- 两端需要先确认"这次呼叫已被接受",再各自加入频道,否则会出现一方已入会、另一方仍在振铃的情况。
因此呼叫需要一条独立于音视频的实时信令通道。如果用 WebSocket 或业务服务端转发自建这条通道,需要同时解决长连接维持与断线重连、按用户路由点对点消息、判断对方是否在线、确认消息是否送达,以及海量连接下的容量与可用性保障。RTM 直接提供这些能力:
| RTM 提供的能力 | 在呼叫中的效果 |
|---|---|
USER 点对点消息 | 呼叫、接听、拒绝、取消、确认五种信令都通过它在两个用户之间直接传递 |
| 点对点消息发送成功即表示对方已收到 | 主叫无需等待额外回执,就能确认邀请已送达对方设备(RECEIVED_BY_CALLEE) |
发送错误码 -11033(对方不在线) | 主叫能明确提示"对方不在线"(PEER_OFFLINE) |
linkState 连接状态 | 发送失败时判断是本端网络问题(LOCAL_NETWORK_ERROR)还是对方问题 |
| 长连接与自动重连 | 网络短暂波动时连接自动恢复 |
2. 设计原则
本节内容与平台无关。
2.1 复用 App 已登录的 RTM client
呼叫邀请模块安装在 App 已有的 RTM client 上,不创建新 client,也不负责登录和登出:
- 传给模块的
userId必须与 RTM 登录时使用的 UID 一致; - 在
login()成功后安装模块; - 登出前先销毁模块,重新登录后重新安装。模块的 dispose() 会解绑模块自身的事件监听,因此销毁后需要创建新的模块实例,才能继续接收来电。
2.2 隔离邀请信令与 App 自有消息
邀请信令使用 USER Channel 点对点发送,并通过以下 customType 标识:
customType | 方向 | 含义 |
|---|---|---|
CALL_KIT_INVITE | 主叫 → 被叫 | 发起呼叫 |
CALL_KIT_ACCEPT(type: "accepted") | 被叫 → 主叫 | 被叫接听 |
CALL_KIT_ACCEPT(type: "ack") | 主叫 → 被叫 | 主叫确认 |
CALL_KIT_REFUSE | 被叫 → 主叫 | 被叫拒绝 |
CALL_KIT_CANCEL | 主叫 → 被叫 | 主叫取消 |
SDK 会把收到的每条消息同时分发给模块和 App 自己注册的 message 监听。模块只处理上述 customType,App 的监听则需要主动跳过它们(代码见 3.3 接收与分发信令)。App 自己的点对点业务消息请使用独立的 customType。
每条邀请信令都可以携带 extra 字段,即 App 自定义字符串,模块原样透传。
2.3 以状态驱动界面
模块在两端各维护一份邀请状态,并在状态变化时回调。App 只需把状态映射到界面:
| 端 | 状态 | 界面 | 可用操作 |
|---|---|---|---|
| 主叫 | SENT_TO_CALLEE | 正在呼叫… | 取消 |
| 主叫 | RECEIVED_BY_CALLEE | 正在呼叫… | 取消 |
| 主叫 | ACCEPTED_BY_CALLEE | 接通中,开始加入 RTC | 挂断 |
| 主叫 | REFUSED_BY_CALLEE / CANCELED / FAILURE | 显示结果后关闭呼叫界面(见 2.6 按失败原因提示用户) | — |
| 被叫 | INVITATION_RECEIVED | 来电界面 | 接听、拒绝 |
| 被叫 | ACCEPT_SENT_TO_CALLER | 接通中 | — |
| 被叫 | ACCEPTED | 开始加入 RTC | 挂断 |
| 被叫 | REFUSED / CANCELED_BY_CALLER / FAILURE | 显示结果后关闭来电界面(见 2.6 按失败原因提示用户) | — |
RECEIVED_BY_CALLEE 表示邀请已送达对方设备,不代表对方已看到来电,因此界面仍显示"正在呼叫"。点击拒绝或取消后,界面立即显示结果,无需等待对方收到。
完整的状态定义与流转见 附录:邀请状态与流转。
2.4 接受即邀请结束,通话交给 RTC
主叫进入 ACCEPTED_BY_CALLEE、被叫进入 ACCEPTED 后,邀请就结束了。之后的通话完全由 RTC 负责:两端各自加入同一个 RTC 频道;挂断只需离开 RTC 频道,对方感知到你离开后结束通话,不需要发送 RTM 消息。
接受不等于接通。以下两种情况都会出现"一方在等待、另一方不会进来":
| 场景 | 主叫 | 被叫 | 结果 |
|---|---|---|---|
| 被叫网络差,没收到确认消息 | 已接受,已加入 RTC | 等待确认超时,邀请失败,不加入 RTC | 双方无法通话 |
| 被叫收到确认,但加入 RTC 失败 | 已接受,已加入 RTC | 已接受,RTC 加入失败 | 双方无法通话 |
因此 App 必须设置媒体等待截止:开始建立 RTC 时计时,未在截止时间内建立媒体就结束本次通话并提示用户。Demo 默认使用 15 秒(代码见 3.6 接通后进入 RTC 与挂断)。
2.5 超时与重试:用默认值,按需调整
模块为邀请的每个等待阶段都设置了截止时间,并会在 INVITE 发送失败时自动重试。以下默认值即 Demo 的建议配置:
| 配置项 | 默认值 | 含义 |
|---|---|---|
sendTimeoutMs | 30000 | 主叫发送邀请的总时长上限,包含重试 |
maxRetries | 2 | 邀请发送失败后的重试次数(首次 + 2 次重试,共 3 次) |
retryIntervalMs | 2000 | 两次重试之间的间隔 |
callerInvitationExpireMs | 30000 | 邀请送达后,主叫等待对方接听或拒绝的时长 |
calleeInvitationExpireMs | 30000 | 被叫从收到来电到完成接通(含等待确认消息)的时长 |
主叫和被叫各自计时,起点不同,因此两端不保证同时到期。
2.6 按失败原因提示用户
邀请结束时,回调中的 state 表示结果,失败时 reason 表示原因。建议按下表给出提示。
主叫
| 结果 | reason | 建议处理 |
|---|---|---|
REFUSED_BY_CALLEE | — | 对方已拒绝 |
CANCELED | — | 已取消 |
FAILURE | PEER_OFFLINE | 对方不在线 |
FAILURE | LOCAL_NETWORK_ERROR / PUBLISH_TIMEOUT / PUBLISH_FAILED / SEND_TIMEOUT | 网络异常,可提供"重新呼叫" |
FAILURE | PEER_NO_RESPONSE | 对方无应答,可提供"再次呼叫" |
FAILURE | STOPPED | 无需提示 |
被叫
| 结果 | reason | 建议处理 |
|---|---|---|
CANCELED_BY_CALLER | — | 对方已取消,可记为未接来电 |
FAILURE | INVITATION_EXPIRE | 来电超时,可记为未接来电 |
FAILURE | ACCEPT_ACK_TIMEOUT | 接通失败 |
FAILURE | LOCAL_NETWORK_ERROR | 网络异常 |
FAILURE | STOPPED | 无需提示 |
排查问题时,回调中的 trigger(触发条件)、sdkError(SDK 原始错误)和 linkStateAtFailure(失败时的网络状态)可以帮助定位原因。
2.7 多来电与占线
模块允许同时存在多个来电,每个来电独立计时、独立处理,不会自动拒绝其他来电。占线策略由 App 决定。
Demo 同一时间只保留一路通话。通话中收到新来电时,来电继续计时,用户可以拒绝;通话结束后,仍在有效期内的来电可以接听。
3. 实现指南
基础接入见 实现收发消息,凭证准备见 部署 Token 服务器 和 客户端鉴权。
以下代码基于 RTM Java SDK 2.x 和 RTC Java SDK 4.x,接口名和参数以实际接入的 SDK 版本为准。
Demo 中的呼叫邀请模块目前只有 Web 版本。本节展示如何用 Java SDK 按同一套信令协议实现模块的关键环节:信令收发、超时与重试、失败原因判断和接通后的 RTC 处理。完整的状态定义与流转以附录为准。
为保证状态读写串行,示例假设所有 SDK 回调都已通过 mainHandler.post() 切换到主线程处理,下文代码不再重复这一步。
示例中主叫和被叫的邀请使用同一个 Invitation 类,用 isCaller 区分角色;State 中的状态名与附录一致。
3.1 信令定义与发送
每条信令都使用 USER Channel 点对点发送,customType 标识信令类型,消息体为 JSON 文本 { callId, extra, type? },其中 type 只用于 CALL_KIT_ACCEPT:
static final String CALL_KIT_INVITE = "CALL_KIT_INVITE";
static final String CALL_KIT_ACCEPT = "CALL_KIT_ACCEPT"; // type: "accepted" 或 "ack"
static final String CALL_KIT_REFUSE = "CALL_KIT_REFUSE";
static final String CALL_KIT_CANCEL = "CALL_KIT_CANCEL";
static final Set<String> CALL_KIT_TYPES = new HashSet<>(Arrays.asList(
CALL_KIT_INVITE, CALL_KIT_ACCEPT, CALL_KIT_REFUSE, CALL_KIT_CANCEL));
void sendSignal(String peerUid, String customType, String callId, String extra,
@Nullable String type, ResultCallback<Void> callback) {
JSONObject body = new JSONObject();
try {
body.put("callId", callId);
body.put("extra", extra == null ? "" : extra);
if (type != null) body.put("type", type);
} catch (JSONException e) {
return;
}
PublishOptions options = new PublishOptions();
options.setChannelType(RtmChannelType.USER);
options.setCustomType(customType);
// USER 消息发送成功即表示对方已收到
rtmClient.publish(peerUid, body.toString(), options, callback);
}
主叫发起呼叫时生成 callId:16 字节随机数转成 32 位大写十六进制字符串。
static String newCallId() {
byte[] bytes = new byte[16];
new SecureRandom().nextBytes(bytes);
StringBuilder sb = new StringBuilder();
for (byte b : bytes) sb.append(String.format("%02X", b));
return sb.toString();
}
3.2 安装与配置
超时与重试参数使用 2.5 超时与重试:用默认值,按需调整 中的默认值,可按业务调整:
final class InvitationOptions {
long sendTimeoutMs = 30_000; // INVITE 发送总截止,包含重试
int maxRetries = 2; // 发送失败后的重试次数
long retryIntervalMs = 2_000; // 重试间隔
long callerInvitationExpireMs = 30_000; // 主叫等待接听或拒绝
long calleeInvitationExpireMs = 30_000; // 被叫处理来电与等待确认
}
在 RTM 登录成功后安装模块:向已登录的 client 添加模块自己的监听,并记录连接状态,用于判断失败原因。安装时由 App 会话传入当前 MESSAGE 服务的连接状态;新加的监听不会重放登录期间已发出的 CONNECTED 事件。后续只处理 MESSAGE 服务事件,忽略 Stream Channel 的连接通知。登出前先销毁模块:移除监听,并将未结束的邀请置为 FAILURE(STOPPED)。
void install(boolean messageLinkConnected) {
linkConnected = messageLinkConnected; // 由 App 会话传入当前 MESSAGE 服务连接状态
rtmClient.addEventListener(invitationListener);
}
void dispose() {
rtmClient.removeEventListener(invitationListener);
for (Invitation inv : invitations.values()) fail(inv, Reason.STOPPED);
}
// invitationListener 中
@Override
public void onLinkStateEvent(LinkStateEvent event) {
if (event.getServiceType() != RtmServiceType.MESSAGE) return;
linkConnected = event.getCurrentState() == RtmLinkState.CONNECTED;
if (event.getCurrentState() == RtmLinkState.FAILED) {
// 连接彻底失败:未结束的邀请全部失败
for (Invitation inv : invitations.values()) fail(inv, Reason.LOCAL_NETWORK_ERROR);
}
// 暂时断连不重置截止,也不立即结束邀请
}
每个阶段使用基于本地单调时钟的截止值 endTs,不与系统日期时间或其他设备的时钟比较。计时器只负责到点唤醒检查;收到消息、用户操作或发送结果时,也先检查截止。App 从后台恢复时,对所有未结束的邀请执行一次 onDeadline 检查。
import android.os.SystemClock;
// Invitation.endTs 为 long,保存单调时钟的毫秒值
boolean isExpired(Invitation inv) {
return SystemClock.elapsedRealtime() >= inv.endTs;
}
void enterStage(Invitation inv, State state, long endTs) {
inv.state = state;
inv.endTs = endTs;
mainHandler.removeCallbacks(inv.deadlineTask);
inv.deadlineTask = () -> onDeadline(inv);
mainHandler.postDelayed(inv.deadlineTask, Math.max(0, endTs - SystemClock.elapsedRealtime()));
notifyStateChanged(inv);
}
void onDeadline(Invitation inv) {
if (inv.ended || !isExpired(inv)) return;
switch (inv.state) {
case SENT_TO_CALLEE: fail(inv, Reason.SEND_TIMEOUT); break;
case RECEIVED_BY_CALLEE: fail(inv, linkConnected ? Reason.PEER_NO_RESPONSE : Reason.LOCAL_NETWORK_ERROR); break;
case INVITATION_RECEIVED: fail(inv, Reason.INVITATION_EXPIRE); break;
case ACCEPT_SENT_TO_CALLER: fail(inv, Reason.ACCEPT_ACK_TIMEOUT); break;
}
}
// 进入终态后不再变化,迟到的消息和发送结果都不能改变它
void end(Invitation inv, State terminal, @Nullable Reason reason) {
if (inv.ended) return;
inv.ended = true;
inv.state = terminal;
inv.reason = reason;
mainHandler.removeCallbacks(inv.deadlineTask);
notifyStateChanged(inv);
}
void fail(Invitation inv, Reason reason) {
end(inv, State.FAILURE, reason); // 主叫为 FAILURE(6),被叫为 FAILURE(16)
}
3.3 接收与分发信令
模块的监听只处理 USER Channel 中 CALL_KIT_ 系列 customType 的消息,按信令类型分发。格式不合法、callId 不存在或发送者不是该邀请的对方时,直接忽略:
// invitationListener 中
@Override
public void onMessageEvent(MessageEvent event) {
if (event.getChannelType() != RtmChannelType.USER) return;
String customType = event.getCustomType();
if (!CALL_KIT_TYPES.contains(customType)) return;
Object data = event.getMessage().getData(); // SDK 返回 String 或 byte[]
if (!(data instanceof String)) return; // 本协议使用 JSON 文本
Signal signal = Signal.parse((String) data); // 格式不合法时返回 null
if (signal == null) return;
String from = event.getPublisherId();
switch (customType) {
case CALL_KIT_INVITE: onInvite(from, signal); break;
case CALL_KIT_ACCEPT:
if ("accepted".equals(signal.type)) onAccepted(from, signal);
else if ("ack".equals(signal.type)) onAck(from, signal);
break;
case CALL_KIT_REFUSE: onRefuse(from, signal); break;
case CALL_KIT_CANCEL: onCancel(from, signal); break;
}
}
@Nullable
Invitation find(String callId, String from, boolean isCaller) {
Invitation inv = invitations.get(callId);
if (inv == null || inv.isCaller != isCaller || !inv.remoteUid.equals(from)) return null;
return inv;
}
如果 App 还会收发其他点对点消息,在 App 自己的监听中跳过邀请信令:
// App 自己的监听中
@Override
public void onMessageEvent(MessageEvent event) {
if (event.getChannelType() == RtmChannelType.USER
&& CALL_KIT_TYPES.contains(event.getCustomType())) {
return; // 交给呼叫邀请模块处理
}
handleAppMessage(event);
}
3.4 主叫:发起与取消
发起呼叫时进入 SENT_TO_CALLEE,并设置发送总截止。发送失败时在截止前按间隔重试,次数耗尽后按 2.6 按失败原因提示用户 判断失败原因。发送成功即进入 RECEIVED_BY_CALLEE,开始等待对方响应:
Invitation call(String calleeUid, String extra) {
Invitation inv = Invitation.outgoing(newCallId(), calleeUid, extra);
invitations.put(inv.callId, inv);
enterStage(inv, State.SENT_TO_CALLEE, SystemClock.elapsedRealtime() + options.sendTimeoutMs);
sendInvite(inv);
return inv;
}
void sendInvite(Invitation inv) {
inv.publishing = true;
sendSignal(inv.remoteUid, CALL_KIT_INVITE, inv.callId, inv.extra, null, new ResultCallback<Void>() {
@Override
public void onSuccess(Void responseInfo) {
if (inv.ended || inv.state != State.SENT_TO_CALLEE || isExpired(inv)) return;
inv.publishing = false;
enterStage(inv, State.RECEIVED_BY_CALLEE,
SystemClock.elapsedRealtime() + options.callerInvitationExpireMs);
}
@Override
public void onFailure(ErrorInfo errorInfo) {
if (inv.ended || isExpired(inv)) return;
inv.publishing = false;
if (inv.retries < options.maxRetries) {
inv.retries++;
mainHandler.postDelayed(() -> {
if (!inv.ended && !isExpired(inv)) sendInvite(inv);
}, options.retryIntervalMs);
} else {
fail(inv, classify(errorInfo));
}
}
});
}
Reason classify(ErrorInfo errorInfo) {
RtmErrorCode code = errorInfo.getErrorCode();
if (code == RtmErrorCode.CHANNEL_RECEIVER_OFFLINE) return Reason.PEER_OFFLINE; // -11033
if (!linkConnected) return Reason.LOCAL_NETWORK_ERROR;
if (code == RtmErrorCode.CHANNEL_PUBLISH_MESSAGE_TIMEOUT) return Reason.PUBLISH_TIMEOUT; // -11026
return Reason.PUBLISH_FAILED;
}
收到接听消息后立即进入接受终态并回复确认消息,不等待确认消息的发送结果。收到拒绝消息则进入拒绝终态:
void onAccepted(String from, Signal signal) {
Invitation inv = find(signal.callId, from, true);
if (inv == null || inv.ended || inv.state != State.RECEIVED_BY_CALLEE || isExpired(inv)) return;
end(inv, State.ACCEPTED_BY_CALLEE, null);
sendSignal(from, CALL_KIT_ACCEPT, inv.callId, inv.extra, "ack", IGNORE_RESULT);
}
void onRefuse(String from, Signal signal) {
Invitation inv = find(signal.callId, from, true);
if (inv == null || inv.ended || inv.state != State.RECEIVED_BY_CALLEE || isExpired(inv)) return;
inv.remoteExtra = signal.extra;
end(inv, State.REFUSED_BY_CALLEE, null);
}
等待期间用户点击取消时,先提交取消终态,再通知对方:
void cancel(Invitation inv) {
if (inv.ended) return;
end(inv, State.CANCELED, null);
sendSignal(inv.remoteUid, CALL_KIT_CANCEL, inv.callId, inv.extra, null, IGNORE_RESULT);
}
在 extra 中放入 RTC 频道名等通话所需信息。
3.5 被叫:接听与拒绝
首次收到合法的邀请时创建来电并开始计时;重复的邀请复用已有来电,不刷新截止。已结束的邀请在去重窗口内保留,避免重复邀请再次触发来电:
void onInvite(String from, Signal signal) {
if (invitations.containsKey(signal.callId)) return;
Invitation inv = Invitation.incoming(signal.callId, from, signal.extra);
invitations.put(inv.callId, inv);
enterStage(inv, State.INVITATION_RECEIVED,
SystemClock.elapsedRealtime() + options.calleeInvitationExpireMs);
}
终态后释放不再需要的回调、计时任务和大体积 extra;仅保留对方 UID、callId、终态及过期时间等最小去重记录。去重缓存应同时设置 TTL 和容量上限,TTL 覆盖本业务允许的发送重试及迟到消息窗口;活动邀请不能因缓存淘汰被删除。定期清理过期记录,账号退出时清空。若要在去重记录淘汰后仍拒绝过期邀请,业务协议还应增加可校验的消息有效期,不能只依赖接收端从“首次收到”开始计时。
用户点击接听时发送接听消息。发送期间 publishing 为 true,界面禁用接听和拒绝按钮;发送成功后进入 ACCEPT_SENT_TO_CALLER,沿用原截止时间等待确认消息;发送失败时来电保持,用户可以再次操作:
void accept(Invitation inv) {
if (inv.ended || inv.state != State.INVITATION_RECEIVED || inv.publishing || isExpired(inv)) return;
inv.publishing = true;
notifyStateChanged(inv);
sendSignal(inv.remoteUid, CALL_KIT_ACCEPT, inv.callId, "", "accepted", new ResultCallback<Void>() {
@Override
public void onSuccess(Void responseInfo) {
if (inv.ended || isExpired(inv)) return;
inv.publishing = false;
enterStage(inv, State.ACCEPT_SENT_TO_CALLER, inv.endTs);
}
@Override
public void onFailure(ErrorInfo errorInfo) {
if (inv.ended) return;
inv.publishing = false;
notifyStateChanged(inv);
}
});
}
void onAck(String from, Signal signal) {
Invitation inv = find(signal.callId, from, false);
if (inv == null || inv.ended || inv.state != State.ACCEPT_SENT_TO_CALLER || isExpired(inv)) return;
end(inv, State.ACCEPTED, null);
}
用户点击拒绝时,先提交拒绝终态,再通知对方。收到取消消息时,进入取消终态:
void refuse(Invitation inv) {
if (inv.ended || inv.state != State.INVITATION_RECEIVED || inv.publishing) return;
end(inv, State.REFUSED, null);
sendSignal(inv.remoteUid, CALL_KIT_REFUSE, inv.callId, "", null, IGNORE_RESULT);
}
void onCancel(String from, Signal signal) {
Invitation inv = find(signal.callId, from, false);
if (inv == null || inv.ended || isExpired(inv)) return;
if (inv.state == State.INVITATION_RECEIVED || inv.state == State.ACCEPT_SENT_TO_CALLER) {
end(inv, State.CANCELED_BY_CALLER, null);
}
}
可用 endTs 显示剩余振铃时间:Math.max(0, inv.endTs - SystemClock.elapsedRealtime())。
3.6 接通后进入 RTC 与挂断
进入接受状态后,由 App 加入 RTC,并设置媒体建立的绝对截止时间(Demo 默认 15 秒)。本地加入成功且确认目标用户的音频已开始播放(onRemoteAudioStateChanged 报告 REMOTE_AUDIO_STATE_DECODING)后,取消媒体等待截止。超时、建立失败或用户挂断时,幂等清理本次媒体会话;邀请保持原有接受终态。
static final long MEDIA_TIMEOUT_MS = 15_000; // App 层配置,Demo 默认 15 秒
private final Runnable mediaTimeout = () -> endCall("对方未接通");
private boolean callActive;
private int remoteRtcUid; // 目标用户的 RTC uid
// 创建 RtcEngine 时通过 RtcEngineConfig.mEventHandler 传入
private final IRtcEngineEventHandler rtcEventHandler = new IRtcEngineEventHandler() {
@Override
public void onRemoteAudioStateChanged(int uid, int state, int reason, int elapsed) {
mainHandler.post(() -> {
if (!callActive || uid != remoteRtcUid) return;
if (state == Constants.REMOTE_AUDIO_STATE_DECODING) {
mainHandler.removeCallbacks(mediaTimeout);
}
});
}
@Override
public void onUserOffline(int uid, int reason) {
mainHandler.post(() -> {
if (callActive && uid == remoteRtcUid) endCall("通话已结束");
});
}
};
void startCall(String rtcChannel, String rtcToken) {
callActive = true;
mainHandler.postDelayed(mediaTimeout, MEDIA_TIMEOUT_MS);
ChannelMediaOptions options = new ChannelMediaOptions();
options.publishMicrophoneTrack = true;
options.autoSubscribeAudio = true;
if (rtcEngine.joinChannel(rtcToken, rtcChannel, localRtcUid, options) != 0) {
endCall("通话建立失败");
}
}
void endCall(String message) {
if (!callActive) return; // 超时、对方离开、用户挂断可能先后触发
callActive = false;
mainHandler.removeCallbacks(mediaTimeout);
rtcEngine.leaveChannel();
showToast(message);
backToIdle();
}
挂断时调用 endCall("通话已结束") 即可。
4. 常见错误
App 的点对点消息监听没有过滤邀请信令
邀请信令会同时到达 App 自己的监听,被当作普通消息解析或展示。在 App 监听中忽略 CALL_KIT_ 系列 customType。
为呼叫邀请单独创建或登录一个 RTM client
同一用户维护多条连接,状态难以一致。模块应安装在 App 已登录的唯一 client 上。
销毁模块后没有重新安装
App 调用 dispose() 后,模块已解绑自身的事件监听。重新登录后需要创建新的模块实例,才能继续接收来电。
用 RTM 消息通知挂断
接受即邀请结束,挂断只需离开 RTC 频道。
把"已接受"当作"已接通"
确认消息可能丢失,RTC 可能加入失败。进入 RTC 时必须设置媒体等待截止。
对所有失败自动重拨,或在 App 层叠加重试
对方不在线时重拨仍会失败,无应答时重拨会打扰对方;模块已自动重试,叠加只会延长等待。
5. 上线检查清单
- 呼叫邀请模块安装在已登录的唯一 RTM client 上,
userId与登录 UID 一致 - 登出前销毁模块,重新登录后重新安装
- App 自有的点对点消息监听忽略
CALL_KIT_系列customType - 界面按 2.3 以状态驱动界面 渲染,
publishing时禁用操作按钮 - 超时与重试配置已按业务确认,App 层未叠加重试
- 主叫和被叫都按 2.6 按失败原因提示用户 给出提示
- 进入 RTC 时设置媒体等待截止,目标用户的媒体就绪后取消
- 挂断只离开 RTC 频道,不发 RTM 消息
- 已定义占线策略
附录:邀请状态与流转
本附录供需要深入了解模块行为或自行实现邀请逻辑的开发者参考。
主叫状态
| 状态 | 含义 |
|---|---|
IDLE(0) | 已创建,尚未开始 |
SENT_TO_CALLEE(1) | 正在发送邀请,包括失败后的重试 |
RECEIVED_BY_CALLEE(2) | 邀请已送达被叫,等待接听或拒绝 |
ACCEPTED_BY_CALLEE(3) | 被叫已接听(终态) |
REFUSED_BY_CALLEE(4) | 被叫已拒绝(终态) |
CANCELED(5) | 主叫已取消(终态) |
FAILURE(6) | 发送失败、等待超时、网络断开或模块销毁(终态) |
被叫状态
| 状态 | 含义 |
|---|---|
IDLE(10) | 已创建,尚未处理邀请 |
INVITATION_RECEIVED(11) | 来电中,等待用户操作;接听消息发送中也保持此状态 |
ACCEPT_SENT_TO_CALLER(12) | 接听消息已送达主叫,等待确认 |
ACCEPTED(13) | 已收到确认(终态) |
REFUSED(14) | 被叫已拒绝(终态) |
CANCELED_BY_CALLER(15) | 主叫已取消(终态) |
FAILURE(16) | 来电超时、确认超时、网络断开或模块销毁(终态) |
模块的消息校验规则
模块收到邀请信令后,以下任一条件不满足即忽略该消息,不影响其他邀请:
- 消息格式合法,字段完整;
callId对应已有的邀请(首次收到的合法邀请会新建被叫邀请);- 消息发送者与该邀请的对方 UID 一致;
- 当前状态允许处理该消息,且未过截止时间。