呼叫邀请

---

功能简介

ZIM SDK 提供了呼叫邀请功能，支持主叫向被叫（可为离线状态）发送呼叫邀请、被叫（可为离线状态）接受或拒绝邀请等完整的业务流程控制能力。呼叫邀请分为两种模式，普通模式与进阶模式。

普通模式的呼叫邀请支持用户发起、取消、接受、拒绝和超时未响应。在此基础上，进阶模式的呼叫邀请还允许用户中途邀请他人、退出以及结束呼叫。

呼叫用户状态说明

呼叫用户状态（ZIMCallUserState），是指用户在呼叫邀请各个环节中的状态。本节主要介绍状态如何流转，以及状态与接口/回调的关系。

状态流转

从呼叫邀请发起到呼叫结束，呼叫用户状态流转如下图所示：

状态与接口/回调的关系

在用户在进行呼叫邀请时，其呼叫用户状态会影响用户是否可以调用某些接口，或者监听某些事件。

• 各状态可调用接口：

  	callInvite	callCancel	callAccept	callReject	callInvite	callQuit	callEnd
  Inviting	与呼叫用户状态无关，只需用户不在呼叫中，即可调用。	与呼叫用户状态无关，只需用户发起邀请后，无人应答即可调用。	✔️	✔️	✖	✖	✖
  Accepted			✖	✖	✔️	✔️	✔️
  Rejected			✖	✖	✖	✖	✖
  Cancelled			✖	✖	✖	✖	✖
  Received			✔️	✔️	✖	✖	✖
  Timeout			✖	✖	✖	✖	✖
  Quit			✖	✖	✖	✖	✖
  Unknown			✖	✖	✖	✖	✖

• 各状态可监听事件：

  	onCallInvitationReceived	onCallInvitationTimeout	onCallInvitationCancelled	onCallInvitationEnded	onCallUserStateChanged
  Inviting	✔️	✔️	✔️	✔️	✔️
  Accepted	✖	✖	✖	✔️	✔️
  Rejected	✖	✖	✖	✖	✖
  Cancelled	✖	✖	✖	✖	✖
  Received	✖	✖	✔️	✔️	✔️
  Timeout	✖	✖	✖	✖	✖
  Quit	✖	✖	✖	✖	✔️
  Unknown	✖	✖	✖	✖	✖

前提条件

在实现“呼叫邀请”功能之前，请确保：

• 已在 ZEGO 控制台 创建项目，获取到了接入 ZIM SDK 服务所需的 AppID、AppSign。ZIM 服务权限不是默认开启的，使用前，请先在 ZEGO 控制台 自助开通 ZIM 服务（详情请参考控制台的 服务配置 - 即时通讯 - 开通服务），若无法开通 ZIM 服务，请联系 ZEGO 技术支持开通。

• 已集成 ZIM SDK，详情请参考 快速开始 - 实现基本收发消息 的 “2 集成 SDK”。

• （可选）如需实现呼叫邀请离线推送，请参考下表。

  呼叫邀请离线推送发起端	呼叫邀请离线推送接收端	接收端配置参考文档
  iOS Android macOS Windows Web 小程序	iOS Android	实现离线推送 - iOS 实现离线推送 - Android

普通模式

普通模式下，呼叫邀请的生命周期在全员响应后随即结束（所有被叫接受、拒绝、邀请超时之后）。以下，我们以客户端 A（邀请者）向客户端 B（被邀请者）发起呼叫邀请为例。

1 监听呼叫邀请相关用户的状态变化

开发者可以监听 onCallUserStateChanged 回调，进而收到呼叫邀请相关用户的状态变化。

示例代码如下：

// 监听呼叫邀请相关用户的状态变化
@Override
public void onCallUserStateChanged(ZIM zim, ZIMCallUserStateChangeInfo info, String callID) {
    super.onCallUserStateChanged(zim, info, callID);

    for(ZIMCallUserInfo userInfo : info.callUserList){

        // 状态发生变化的 userID
        String userID = userInfo.userID;

        // 该用户当前最新状态
        ZIMCallUserState state = userInfo.state;

        // 透传字段，与用户调用接受、拒绝、退出接口时携带的 extended data 内容一致
        String extendedData = userInfo.extendedData;
    }
}

2 发起呼叫邀请

客户端 A 向客户端 B 发起呼叫邀请时，流程如下：

1. 客户端 A 注册 onCallInvitationCreated 回调接口，以便接收呼叫邀请已创建的通知；客户端 B 通过注册 onCallInvitationReceived 回调接口，以便接收客户端 A 的邀请通知。

2. 客户端 A 通过调用 callInvite 接口，发起呼叫邀请，客户端 B 在收到邀请信息后，可以选择 接受 或者 拒绝。

   若客户端 B 为离线用户：

   • 在 timeout（邀请超时时间）内登录，即可通过 onCallInvitationReceived 收到呼叫邀请通知。
   • 在 timeout 外登录，请调用 queryCallInvitationList 来 查询呼叫邀请列表。

callInvite 说明

public abstract void callInvite(List<String> invitees, ZIMCallInviteConfig config,
                                ZIMCallInvitationSentCallback callback);

示例代码

• 发送呼叫邀请

  // 发送呼叫邀请
  List<String> invitees = new ArrayList<String>(); // 被邀请人列表
  invitees.add("421234");       // 被邀请人id
  ZIMCallInviteConfig config = new ZIMCallInviteConfig(); 
  config.timeout = 200; // 邀请超时时间，单位为秒，范围 1-600 
  
  // （可选）需要向离线用户发起呼叫邀请并推送相关离线通知时填写
  ZIMPushConfig pushConfig = new ZIMPushConfig();
  pushConfig.title = "your title";
  pushConfig.content = "your content";
  pushConfig.payload = "your payload";
  config.pushConfig = pushConfig;
  
  zim.callInvite(invitees, config, new ZIMCallInvitationSentCallback() {
      @Override
      public void onCallInvitationSent(String callID, ZIMCallInvitationSentInfo info, ZIMError errorInfo) {
          // 此处的 callID 是用户发起呼叫后，SDK 内部生成的 ID，用于唯一标识一次呼叫邀请；之后发起人取消呼叫、被邀请人接受/拒绝呼叫，都会使用此 callID
      }
  });

• 邀请发起者收到呼叫邀请已创建的通知，示例代码如下：

  /** 邀请发起者收到呼叫邀请已创建的通知 */
  zim.setEventHandler(new ZIMEventHandler() {
       @Override
      public void onCallInvitationCreated(ZIM zim, ZIMCallInvitationCreatedInfo info, String callID) {
  
      }
  });

• 被邀请者收到邀请后的回调通知

  // 被邀请者收到邀请后的回调通知
  zim.setEventHandler(new ZIMEventHandler() {
      @Override
      void onCallInvitationReceived(ZIM zim, ZIMCallInvitationReceivedInfo info, String callID) {
  
      } 
  });

3 取消呼叫邀请

客户端 A 向客户端 B 发起呼叫邀请后、又取消邀请时，流程如下：

1. 客户端 A 发起呼叫邀请后，如果需要取消，可以调用 callCancel 接口，主动选择取消当前邀请。

   在呼叫邀请成功创建后至其超时前，如果没有任何被叫用户接受，主叫用户主动登出或因心跳超时而掉线，也会导致呼叫邀请被取消。

2. 邀请取消后，客户端 B 会收到 onCallInvitationCancelled 回调接口的相关通知。

callCancel 说明

public abstract void callCancel(List<String> invitees, String callID,
                                ZIMCallCancelConfig config, ZIMCallCancelSentCallback callback);

示例代码

• 取消呼叫邀请

  // 取消呼叫邀请
  List<String> invitees;  // 被邀请人列表
  invitees.add("421234");       // 被邀请人id
  String callid = "12352435";        // callid
  ZIMCallCancelConfig config = new ZIMCallCancelConfig();
  
  ZIM.getInstance().callCancel(invitees, callid, config, new ZIMCallCancelSentCallback() {
      @Override
      public void onCallCancelSent(String callID, ArrayList<String> errorInvitees, ZIMError errorInfo) {
  
      }
  });

• 被邀请者收到取消邀请后的回调通知

  // 被邀请者收到取消邀请后的回调通知
  ZIM.getInstance().setEventHandler(new ZIMEventHandler() {
      @Override
      void onCallInvitationCancelled(ZIM zim, ZIMCallInvitationCancelledInfo info, String callID) {
  
      } 
  
  });

4 接受呼叫邀请

客户端 B 收到客户端 A 的呼叫邀请后，选择接受邀请时，流程如下：

1. 客户端 B 收到客户端 A 发来的呼叫邀请后，通过调用 callAccept 接口，接受该邀请。
2. 客户端 B 接受邀请后，客户端 A 可以通过 onCallUserStateChanged 回调接口，收到相关通知。如果是在多人呼叫中，则所有现有呼叫成员都可通过此回调收到相关通知。

callAccept 说明

public abstract void callAccept(String callID, ZIMCallAcceptConfig config,
                                ZIMCallAcceptanceSentCallback callback);

示例代码

• 接受呼叫邀请

  String callid = "12352435";        // callid
  ZIMCallAcceptConfig config = new ZIMCallAcceptConfig();
  ZIM.getInstance().callAccept(callid, config, new ZIMCallAcceptanceSentCallback() {
      @Override
      public void onCallAcceptanceSent(String callID, ZIMError errorInfo) {
  
      }
  });

• 呼叫成员收到有用户接受呼叫邀请的通知

  ZIM.getInstance().setEventHandler(new ZIMEventHandler() {
      @Override
      public void onCallUserStateChanged(ZIM zim, ZIMCallUserStateChangeInfo info, String callID) {
      // 所有状态为“Inviting”、“Accepted“和“Received”的用户可在此处收到有用户接受呼叫邀请的通知
      }
  
  });

5 拒绝呼叫邀请

客户端 B 收到客户端 A 的呼叫邀请后，选择拒绝邀请时，流程如下：

1. 客户端 B 收到客户端 A 发来的呼叫邀请后，通过调用 callReject 接口，拒绝该邀请。
2. 客户端 B 拒绝邀请后，客户端 A 可以通过 onCallUserStateChanged 回调接口，收到相关通知。如果是在多人呼叫中，则所有现有呼叫成员都可通过此回调收到相关通知。

callReject 说明

public abstract void callReject(String callID, ZIMCallRejectConfig config,
                                ZIMCallRejectionSentCallback callback);

示例代码

• 拒绝呼叫邀请

  String callid = "12352435";        // callid
  ZIMCallRejectConfig config = new ZIMCallRejectConfig();
  ZIM.getInstance().callReject(callid, config, new ZIMCallRejectionSentCallback() {
      @Override
      public void onCallRejectionSent(String callID, ZIMError errorInfo) {
  
      }
  });

• 呼叫成员收到有用户拒绝呼叫邀请的通知

  ZIM.getInstance().setEventHandler(new ZIMEventHandler() {
      @Override
      public void onCallUserStateChanged(ZIM zim, ZIMCallUserStateChangeInfo info, String callID) {
          // 所有状态为“Inviting”、“Accepted“和“Received”的用户可在此处收到有用户拒绝呼叫邀请的通知
      }
  
  });

6 超时未响应呼叫邀请

客户端 B 收到客户端 A 的呼叫邀请后，客户端 B 长时间未响应时，流程如下：

1. 客户端 A（邀请者）通过 onCallUserStateChanged 回调接口，收到邀请超时、客户端未响应的通知。如果是在多人呼叫中，则所有现有呼叫成员都可通过此回调收到相关通知。
2. 客户端 B（被邀请者）通过 onCallInvitationTimeout 回调接口，收到邀请超时、自己未响应的通知。

ZIM.getInstance().setEventHandler(new ZIMEventHandler() {
    @Override
    public void onCallUserStateChanged(ZIM zim, ZIMCallUserStateChangeInfo info, String callID){
        // 所有状态为“Inviting”、“Accepted“和“Received”的用户可在此处收到有用户呼叫邀请超时的通知
    }

    @Override
    public void onCallInvitationTimeout(ZIM zim, String callID) {
    // 被邀请者响应超时后，“被邀请者”收到的回调通知，超时时间单位：秒
    }     
});

进阶模式

如果您想要实现更为丰富的用户状态场景，比如多人呼叫邀请业务场景，可以参考本节内容实现进阶模式的呼叫邀请。

发起进阶模式的呼叫邀请后，呼叫邀请的生命周期延长至用户主动调用 callEnd 接口结束呼叫。在结束呼叫之前，用户还可以实现在呼叫中继续邀请他人以及退出呼叫的功能。

发起进阶模式的呼叫邀请

开发者在调用 callInvite 接口时主动设置模式为进阶模式，才能发起进阶模式的呼叫邀请。

示例代码：

/** 向用户发送呼叫邀请 - 进阶模式 */
// 发送呼叫邀请
List<String> invitees;  // 被邀请人列表
invitees.add("421234");       // 被邀请人id
ZIMCallInviteConfig config = new ZIMCallInviteConfig(); 
config.timeout = 200; // 邀请超时时间，单位为秒，范围 1-600 
//  mode 为呼叫邀请模式，ADVANCED 表示进阶模式。
config.mode = ADVANCED;

// （可选）需要向离线用户发起呼叫邀请时填写
ZIMPushConfig pushConfig = new ZIMPushConfig();
pushConfig.title = "your title";
pushConfig.content = "your content";
pushConfig.payload = "your payload";
config.pushConfig = pushConfig;

zim.callInvite(invitees, config, new ZIMCallInvitationSentCallback() {
    @Override
    public void onCallInvitationSent(String callID, ZIMCallInvitationSentInfo info, ZIMError errorInfo) {
        // 此处的 callID 是用户发起呼叫后，SDK 内部生成的 ID，用于唯一标识一次呼叫邀请；之后发起人取消呼叫、被邀请人接受/拒绝呼叫，都会使用此 callID
    }
 });

呼叫中邀请

在创建进阶模式呼叫邀请后，状态为 Accepted 的用户可以调用 callingInvite 接口向不在本呼叫中的用户发起邀请。但是，同一个呼叫中的参与用户不能超过 10 人（含邀请创建用户）。

示例代码

• 呼叫中邀请

  // 呼叫中邀请
  ArrayList<String> inviteesList = new ArrayList<>();
  inviteesList.add("inviteesA");
  inviteesList.add("inviteesB");
  ZIMCallingInviteConfig inviteConfig = new ZIMCallingInviteConfig();
  // callID 通过创建进阶模式呼叫邀请的回调获取
  ZIM.getInstance().callingInvite(inviteesList, callID, inviteConfig, new ZIMCallingInvitationSentCallback() {
      @Override
      public void onCallingInvitationSent(String callID, ZIMCallingInvitationSentInfo info, ZIMError errorInfo) {
          if(errorInfo.code != ZIMErrorCode.SUCCESS){
              //根据官网错误码表处理
          }
          //邀请成功后的业务逻辑
      }
  });

• 呼叫成员收到正在邀请其他用户的通知

  ZIM.getInstance().setEventHandler(new ZIMEventHandler() {
      @Override
      public void onCallUserStateChanged(ZIM zim, ZIMCallUserStateChangeInfo info, String callID){
          // 所有用户状态为“呼叫中”和“已接受”的用户可在此处收到有用户被呼叫邀请的通知
      }
  });

主动加入呼叫或切换设备

实现进阶模式呼叫邀请后，以下两种情况下，可以调用 callJoin 接口：

• 没有加入呼叫的用户希望加入呼叫。
  • 对于呼叫外用户加入成功的场景，该用户的状态将流转为 accepted，此时呼叫中的所有用户收到 onCallUserStateChanged 的通知回调。
• 多端登录用户使用设备 A 发起或接受邀请后，希望让其他设备成为新的主设备。
  • 对于切换设备的场景，呼叫内其他用户无感知。

示例代码

// 主动加入呼叫或切换设备

ZIMCallJoinConfig config = new ZIMCallJoinConfig();
config.extendedData = "extendedData";
ZIM.getInstance().callJoin(callID, config, new ZIMCallJoinSentCallback() {
    @Override
    public onCallJoinSent(String callID, ZIMCallJoinSentInfo info, ZIMError errorInfo) {
        if(errorInfo.code == ZIMErrorCode.SUCCESS){
            // 加入成功后的业务逻辑
        } else{
            // 根据官网错误码表处理错误
        }
    }
});

退出呼叫

实现进阶模式呼叫邀请后，呼叫用户状态为 Accepted 的用户可调用 callQuit 接口退出呼叫。退出成功后，该用户的状态将流转为 quit，该用户和仍在呼叫中的其他用户都将会收到 onCallUserStateChanged 的通知回调。

示例代码

• 退出呼叫

  // 退出呼叫
  ZIMCallQuitConfig config = new ZIMCallQuitConfig();
  // callID 通过创建进阶模式呼叫邀请的回调获取
  ZIM.getInstance().callQuit(callID, config, new ZIMCallQuitSentCallback() {
      @Override
      public void onCallQuitSent(String callID, ZIMCallQuitSentInfo info, ZIMError errorInfo) {
          if(errorInfo.code == ZIMErrorCode.SUCCESS){
              // 退出成功后的业务逻辑
          }else {
              // 退出成功后的业务逻辑
          }
      }
  });

• 呼叫成员收到有用户退出呼叫的通知

  ZIM.getInstance().setEventHandler(new ZIMEventHandler() {
      @Override
      public void onCallUserStateChanged(ZIM zim, ZIMCallUserStateChangeInfo info, String callID){
          // // 退出用户本人和用户状态为 “inviting”, “received” 和 “accept” 的其他用户可在此处收到有用户退出呼叫的通知
  581    
      }
  });  

结束呼叫

实现进阶模式呼叫邀请后，呼叫用户状态为 Accepted 的用户可调用 callEnd 接口结束呼叫。此后，所有人的状态保持不变，该呼叫的状态（callState）变为 end，状态为 Iniviting、Accepted 和 Received 的用户将会收到 onCallInvitationEnded 的通知回调。

示例代码

• 结束呼叫

  // 结束呼叫
  ZIMCallEndConfig endConfig = new ZIMCallEndConfig();
  // callID 通过创建进阶模式呼叫邀请的回调获取
  ZIM.getInstance().callEnd(callID, endConfig, new ZIMCallEndSentCallback() {
      @Override
      public void onCallEndSent(String callID, ZIMCallEndSentInfo info, ZIMError errorInfo) {
          if(errorInfo.code == ZIMErrorCode.SUCCESS){
              // 结束成功后的业务逻辑
          }else{
                      // 根据官网错误码表处理错误
                  }
              }
          });

• 呼叫成员收到呼叫结束的通知

  ZIM.getInstance().setEventHandler(new ZIMEventHandler() {
      @Override
      public void onCallInvitationEnded(ZIM zim, ZIMCallInvitationEndedInfo info, String callID) {
          super.onCallInvitationEnded(zim, info, callID);
      }
  });

更多功能

检测邀请是否送达

如需让邀请内在线用户了解其他用户是否收到邀请，从而实现相关业务逻辑，请在发起呼叫邀请时，将 ZIMCallInviteConfig 中的 enableNotReceivedCheck 修改为 true，从而开始检测邀请是否送达。

ZIMCallInviteConfig config = new ZIMCallInviteConfig();
//开启暂未送达检测
config.enableNotReceivedCheck = true;

// 发起呼叫邀请相关代码

主叫发起呼叫邀请后，如果被叫在 5 秒内（可联系 ZEGO 技术支持将间隔调整为 3 秒或 4 秒）因断网、未上线等原因没有接收到本次邀请：

• 若该被叫客户端使用 2.14.0 之后版本的 ZIM SDK，其用户状态将会流转为 ZIMCallUserState.NOT_YET_RECEIVED，表示邀请暂未送达。此时可实现业务逻辑，向呼叫邀请内在线用户展示“该用户可能不在线，暂时无法接收呼叫邀请”等 UI 提示。
• 若该被叫客户端使用 2.14.0 及之前版本的 ZIM SDK，其用户状态仍然保持为 ZIMCallUserState.INVITING。如果该状态保持 5 秒以上，也可以实现上述业务逻辑。

随后，如果在邀请超时前，该被叫用户上线并接收该邀请，该成员的用户状态将流转为 ZIMCallUserState.RECEIVED。

查询呼叫邀请列表

通过调用 queryCallInvitationList 接口，用户可以查询与自己相关的呼叫邀请列表，单次查询上限为 100 条，超过 100 条按 100 处理。

// 查询用户自己的呼叫邀请列表 

ZIMCallInvitationQueryConfig queryCallListConfig = new ZIMCallInvitationQueryConfig();
queryCallListConfig.count = 20;
queryCallListConfig.nextFlag = 0;
ZIM.getInstance(). queryCallInvitationList(queryCallListConfig, new ZIMCallInvitationListQueriedCallback() {
    @Override
    public void onCallListQueried(ArrayList<ZIMCallInfo> callList, long nextFlag, ZIMError errorInfo) {
        if(errorInfo.code != ZIMErrorCode.SUCCESS){
            // 根据官网错误码表处理错误
            return;
        }
        if(nextFlag != 0){
            // 如果 callback 返回的 nextFlag 不为 0，代表没有完成查询所有的呼叫邀请信息。下次查询时可以传入 callback 返回的 nextFlag 继续查询剩余呼叫邀请信息
            queryCallListConfig.nextFlag = nextFlag;
        }
    }
});