新手接入指南

更新时间: 2023/08/15 02:17:57

产品概述

信令SDK是网易云信提供的稳定可靠的信令通道,可用于搭建音视频场景下的呼叫邀请机制。信令SDK目前兼容市面上所有主流的音视频SDK,呼叫到达率高达100%,支持离线推送自定义控制消息,是功能最丰富、稳定性最高的信令SDK之一。

核心功能

信令SDK目前支持以下功能:

  • 呼叫邀请
  • 频道管理
  • 用户管理
  • 离线消息同步
  • 多端同步
  • 自定义控制信令

信令SDK可搭配网易云信即时通信产品一起使用,也可以单独使用。

网易云信的音视频通话产品已支持呼叫功能,可直接使用,邀请功能可通过信令SDK实现。

具体参见:网易云信音视频开发手册

平台支持

信令 SDK 目前支持的平台包括 iOSAndroidWindowsmacOSWeb

音视频通话 1.0 和白板产品不支持信令 macOS 版本。

平台
SDK 兼容性
iOS 兼容 iOS 8.0及以上
Android 兼容 Android 4.0及以上
Windows 包含C 、 C++ 和 C#,兼容 Windows xp ( sp2 及以上)、Windows 7、Windows 8/8.1、Windows 10。
全面支持32位和64位程序接入
macOS 兼容 macOS 10.10 及以上 (x86_64 与 ARM64架构)
Web 兼容 IE8 及以上、Chrome、Firefox、Safari等

接入指南

1. 创建账号

如果您还没有网易云信账号,请访问注册

如果您已经有网易云信账号,请直接登录

2. 创建应用

创建应用是体验或使用网易云信各款产品和服务的首要前提,您可以参考创建应用文档在网易云信控制台创建一个应用,并查看该应用的 App Key。

3. 开通功能

信令功能需要在 IM 即时通讯产品下单独开通,因此试用信令需要先开通 IM 服务。

  1. 在控制台首页应用管理选择应用进入应用配置页面,然后单击 IM即时通讯下的功能配置进入 IM 功能配页。

    已开通.png

  2. 在顶部选择基本功能,开启信令功能。

    信令.png

  3. 阅读并确认信息后,单击确认开通信令。

4.账号集成

为了使用信令SDK,需要在客户端上登录网易云信的账号,账号的集成和登录请参见:账号集成与登录

如果需要在您的服务器上创建网易云信的账号,请查看: 服务端 API 文档

5.客户端集成

6.服务端集成

服务端集成文档:信令服务端 API 参考

一对一会话操作流程

开发者可以使用信令SDK与其他音视频SDK搭配,开发双人通话的应用,操作流程如下:

sequenceDiagram
participant A as 主叫
participant A1 as 主叫音视频SDK
participant B1 as 被叫音视频SDK
participant B as 被叫

A->>A: 登录IM账号
B->>B: 登录IM账号

opt 呼叫的逻辑,可以只用call接口
A->>A: 创建频道
A->>A: 加入频道
A->>B: 邀请加入
end

B->>A: 接收邀请
B->>B: 加入频道

B-x A:收到加入频道通知
A-->>A1: 初始化并加入频道
B-->>B1: 初始化并加入频道
A1-->B1:音视频SDK通话逻辑

opt 切换至音频通话  
A->>B:发送自定义控制命令:只进行音频通话
B-->>B1:调用相关操作切换至音频通话
B->>A:发送自定义控制命令:已切换到音频通话
A-->>A1: 切换至音频通话
end

opt 主叫主动挂断电话
A->>A:离开频道
A-->>A1:断开音视频通话
A->>B:离开频道通知
B-->>B1:断开音视频通话
end

多人会话操作流程

开发者可以使用信令SDK与其他音视频SDK搭配,开发多人会话的应用,操作流程如下:

sequenceDiagram
participant A as 邀请者
participant A1 as 邀请者音视频SDK
participant B1 as 被邀请者音视频SDK
participant B as 被邀请者

A->>A: 登录IM账号
B->>B: 登录IM账号


A->>A: 创建频道
A->>A: 加入频道
A-->>A1: 初始化并加入频道
A->>B: 邀请加入


B->>A: 接收邀请
B->>B: 加入频道
B->>+ A: 加入频道通知
B-->>B1: 初始化并加入频道
A->>A:ui界面展示
A-->>-A1:对被邀请者的处理

opt 发送自定义控制命令  
A->>B:发送自定义控制命令
B-->>B1:执行自定义控制相关操作
end

opt 被邀请者离开多人通话
B->>B:离开频道
B->>A: 离开频道通知
A-->>A1:对被邀请者的处理
B-->>B1:断开音视频通话
end
此文档是否对你有帮助?
有帮助
去反馈
  • 产品概述
  • 核心功能
  • 平台支持
  • 接入指南
  • 1. 创建账号
  • 2. 创建应用
  • 3. 开通功能
  • 4.账号集成
  • 5.客户端集成
  • 6.服务端集成
  • 一对一会话操作流程
  • 多人会话操作流程