文档

管理通话应用

更新时间:

在通话应用列表页面,您可以查看通话应用的详细信息,以及配置音视频通话等相关功能。

查看通话应用

在通话应用列表页面,您可以查看通话应用的名称、bizName、自动录制状态、创建时间以及密钥。

  • 通话应用名称:创建应用时输入的名称,可编辑。

  • bizName:音视频通话场景码,应用创建后自动生成。使用同一个 bizName 的各个终端之间可以进行音视频通话。

  • 自动录制状态:自动录制是否开启。可点击 操作 列中的 功能配置 进行配置。

  • 创建时间:通话应用的创建时间。

  • 密钥:应用创建后自动生成,用于在服务端生成签名。点击 查看文档 可查看密钥使用说明。

功能配置

在通话应用列表页,点击应用 操作 列中的 功能配置,打开当前应用的功能配置页面。您可以在此页面配置云端自动录制、设置媒体流代理服务器地址。

配置时您需要点击 编辑 按钮进入编辑模式;配置完成后,点击 保存 按钮,保存您的配置信息。

配置云端自动录制及录制回调地址

云端自动录制指音视频通话服务端对通话内容自动进行录制的功能。您可以根据需要启用或关闭此功能,并设置录制回调地址。

  • 云端自动录制:开启该功能时,在音视频通话发起时服务端会自动对通话内容进行录制。通话结束时会结束录制,并生成录制文件。关闭时,服务端不进行自动录制。

    说明

    云端录制的默认状态为 停用,需手动开启。

  • 设置录制回调地址:录制回调地址为使用 HTTP 或 HTTPS 协议的 URL。设置录制回调地址后,当开始录制、暂停录制、结束录制或录制文件出现异常时,服务端会将相关状态信息发送到该 URL。

    服务端使用 POST(application/json) 方式回调,回调请求的字段含义如下所示。

    字段

    字段类型

    是否必传

    说明

    bizRequestId

    String

    请求 ID。

    bizName

    String

    业务标识。

    appId

    String

    mPaaS 应用的 ID。

    workspaceId

    String

    工作空间 ID。

    roomId

    String

    房间号 ID。

    recordId

    String

    录制 ID。

    eventCode

    Int

    0:录制某条流成功。

    10:初始化成功。

    11:录制结束。

    50:录制警告。

    99:录制结果。

    500301:流断开警告。

    500302:低帧率警告。

    1000xx:录制启动阶段失败。

    100001:连接 room 失败。

    100002:加入房间失败。

    100003:订阅流失败。

    100004:订阅路数缺失。

    100005:连接 mcu 失败。

    100006:视频长宽比异常。

    100007:实际自定义混流流数大于设置数目。

    1001xx:录制过程中失败。

    100101:录制文件创建失败。

    100102:录制文件格式转换失败。

    100103:文件保存失败。

    100104:音视频分离失败。

    100105:录制子进程崩溃。

    100106:磁盘满或者写文件失败。

    1002xx:录制结束阶段失败。

    100201:上传文件失败。

    recordResult

    JSON

    • 当 eventCode 的值为 99 时必传。json body 如下: status:int,录制状态,必传。

      • 2:代表录制成功,持久化文件成功。

      • 3:代表录制失败。

    • fileType:int,文件类型,当 status 的值为 2 时传输。

      • 1:local

      • 2:OSS

      • 3:AFTS

      • 4:HDFS

    • filePath:String,文件路径,当 status 的值为 2 时传输。

    • recordStartTime:long,录制第一帧的绝对时间(服务器时间,单位为 ms),当 status 的值为 2 时传输。

    • mediaType:int,录制文件的类型,当 status 的值为 2 时传输。

      • 0:音视频

      • 1:纯音频

      • 2:纯视频

    业务服务器需返回的数据字段如下:

    字段

    类型

    是否必传

    说明

    bizRequestId

    String

    回调请求中的bizRequestId

    code

    int

    状态码,成功为 0

    数据示例如下。请求数据示例:

    {
    "bizRequestId":"123456789",
    "bizName":"bizName",
    "appId":"appId",
    "workspaceId":"workspaceId",
    "roomId":"xxxxxx",
    "recordId":"record_xxx",
    "eventCode":0,
    "recordResult": {
        "status":2,
        "fileType":2,
        "filePath":"https://xxxxxx",
        "recordStartTime":1592817186122,
        "mediaType":0
    }
    }

    返回数据示例:

    {
    "bizRequestId":"123456789",
    "code":0
    }

配置房间状态回调地址

房间状态回调地址为使用 HTTP 或 HTTPS 协议的 URL。设置房间状态回调地址后,当创建房间、加入房间、离开房间或销毁房间时,服务端会将相关状态信息发送到该 URL 地址。

服务端使用 POST(application/json) 方式回调,回调请求的字段含义如下所示。

字段

字段类型

是否必传

说明

bizRequestId

String

请求 ID。

uid

String

用户 ID。

bizName

String

业务标识。

appId

String

mPaaS 应用的 ID。

workspaceId

String

工作空间 ID。

roomId

String

房间号 ID。

eventCode

Int

1:创建房间。

2:加入房间。

3:离开房间。

4:销毁房间。

业务服务器需返回的数据字段如下:

字段

类型

是否必传

说明

bizRequestId

String

回调请求中的bizRequestId

code

int

状态码,成功为 0

数据示例如下。请求数据示例:

{
"eventCode":3,
"uid":"uid",
"bizName":"bizName",
"appId":"appId",
"bizRequestId":918479352902861,
"time":1669184793529,
"roomId":"roomId",
"workspaceId":"workspaceId"
} 

配置代理服务器地址

若您的网络中存在安全隔离区,无法直接访问阿里云服务器,可通过设置代理服务器对媒体流数据进行转发。设置媒体流代理服务器后,音视频流数据将通过该代理服务器进行转发。

重要

代理服务器地址错误会导致音视频通话异常,若无必要请勿填写。

配置时需分别填入服务器地址和地址对应的出网 IP,请确保输入的地址准确。

  • 媒体流代理服务器地址格式为:example.aliyundoc.com

  • 若存在多个出网 IP,使用半角分号(;)隔开。

  • 本页导读 (0)
文档反馈