Windows/macOS

新手接入指南

更新时间: 2024/06/12 16:05:59

信令 SDK 是网易云信提供的稳定可靠的信令通道,可用于搭建音视频场景下的呼叫邀请机制。

信令 SDK 目前兼容市面上所有主流的音视频 SDK,呼叫到达率高达 100%,支持离线推送自定义控制消息,是功能最丰富、稳定性最高的信令 SDK 之一。

本文主要介绍如何快速接入云信信令。

1. 创建账号

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

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

2. 创建应用

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

3. 开通功能

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

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

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

    信令.png

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

4.账号集成

为了使用信令 SDK,需要在客户端上登录云信 IM 账号,云信 IM 账号的获取请参考注册 IM 账号

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.服务端集成
  • 一对一会话操作流程
  • 多人会话操作流程