tencent cloud

文档反馈

输入在线媒体流回调

最后更新时间:2024-08-01 16:20:07
    服务端输入在线媒体流回调支持将您使用 输入在线媒体流 REST API 产生输入在线媒体流的事件,以 HTTP/HTTPS 请求的形式通知到您的服务器。您可以向腾讯云提供相关的配置信息来开通该服务。

    配置信息

    实时音视频 TRTC 控制台支持自助配置回调信息,配置完成后即可接收事件回调通知。详细操作指引请参见 回调配置
    注意:
    您需要提前准备以下信息:
    必要项:接收回调通知的 HTTP/HTTPS 服务器地址。
    可选项:计算签名的 密钥 key,由您自定义一个最大32个字符的 key,以大小写字母及数字组成。

    超时重试

    事件回调服务器在发送消息通知后,5秒内没有收到您的服务器的响应,即认为通知失败。首次通知失败后会立即重试,后续失败会以10秒的间隔继续重试,直到消息存续时间超过1分钟,不再重试。

    事件回调消息格式

    事件回调消息以 HTTP/HTTPS POST 请求发送给您的服务器,其中:
    字符编码格式:UTF-8。
    请求:body 格式为 JSON。
    应答:HTTP STATUS CODE = 200,服务端忽略应答包具体内容,为了协议友好,建议客户应答内容携带 JSON: {"code":0}。
    包体示例:下述为“输入在线媒体流开始成功”事件的包体示例。
    {
    "EventGroupId": 7,
    "EventType": 701,
    "CallbackMsTs": 1701937900012,
    "EventInfo": {
    "EventMsTs": 1701937900013,
    "TaskId":"xx",
    "Status":0
    }
    }

    参数说明

    回调消息参数

    事件回调消息的 header 中包含以下字段:
    字段名
    Content-Type
    application/json
    Sign
    签名值
    SdkAppId
    sdk application id
    事件回调消息的 body 中包含以下字段:
    字段名
    类型
    含义
    EventGroupId
    Number
    事件组ID,混流转推事件固定为4
    EventType
    Number
    回调通知的事件类型
    CallbackMsTs
    Number
    事件回调服务器向您的服务器发出回调请求的 Unix 时间戳,单位为毫秒
    EventInfo
    JSON Object

    事件组 ID

    字段名
    含义
    EVENT_GROUP_STREAM_INGEST
    7
    输入在线媒体流事件组

    事件类型

    字段名
    含义
    EVENT_TYPE_STREAM_INGEST_START
    701
    输入在线媒体流开始
    EVENT_TYPE_STREAM_INGEST_STOP
    702
    输入在线媒体流停止

    事件类型为(EVENT_TYPE_STREAM_INGEST_START 701)时事件信息的定义:

    字段名
    类型
    含义
    EventMsTs
    String
    事件发生的 Unix 时间戳,单位为毫秒
    TaskId
    String
    输入在线媒体流任务 ID
    Status
    Number

    输入在线媒体流开始状态

    字段名
    含义
    回调频率
    STATUS_START_SUCCESS
    0
    输入在线媒体流开始成功
    成功时回调1次
    STATUS_START_FAILURE
    1
    输入在线媒体流开始失败
    失败时回调一次
    STATUS_START_AGAIN
    2
    输入在线媒体流再次开始
    在0,1,3秒时重试,重试时回调

    输入在线媒体流状态推荐处理

    状态
    处理方法
    STATUS_START_SUCCESS
    表示成功,无需处理。
    STATUS_START_FAILURE
    当您收到三个输入在线媒体流失败的状态,请检查源流URL,重新发起输入在线媒体流
    STATUS_START_AGAIN
    开始输入在线媒体流1分钟内收到:表示URL建连失败,或RTMP推流失败,系统自动触发重试,若最终失败请检查URL是否正常建立连接
    开始输入在线媒体流1分钟后收到:可能是源流或后台网络抖动引起触发重新拉起,无需处理。

    基本回调转移示例

    输入在线媒体流失败/输入在线媒体流再次开始/输入在线媒体流开始成功的事件转移 STATUS_START_FAILURE -> STATUS_START_AGAIN -> STATUS_START_SUCCESS
    注意:
    输入在线媒体流回调有可能会乱序到达您的回调服务器,此时您需要根据 EventInfo 中的 EventMsTs 做事件排序,如果您只关心 URL 最新状态,可以忽略后续到达的过期事件。

    事件类型为(EVENT_TYPE_STREAM_INGEST_STOP 702)时事件信息的定义:

    字段名
    类型
    含义
    EventMsTs
    String
    事件发生的 Unix 时间戳,单位为毫秒
    TaskId
    String
    输入在线媒体流任务 ID
    Status
    Number

    输入在线媒体流停止状态

    字段名
    含义
    回调频率
    STATUS_STOP_SUCCESS
    0
    输入在线媒体流停止成功
    成功时回调1次

    计算签名

    签名由 HMAC SHA256 加密算法计算得出,您的事件回调接收服务器收到回调消息后,通过同样的方式计算出签名,相同则说明是腾讯云的实时音视频的事件回调,没有被伪造。签名的计算如下所示:
    //签名 Sign 计算公式中 key 为计算签名 Sign 用的加密密钥。
    Sign = base64(hmacsha256(key, body))
    注意:
    body 为您收到回调请求的原始包体,不要做任何转化,示例如下:
    body="{\\n\\t\\"Ebody="{\\"EventGroupId\\":7,\\"EventType\\":701,\\"CallbackMsTs\\":1701937900012,\\"EventInfo\\":{\\"EventMsTs\\":1701937900012,\\"TaskId\\":\\"WMdqEeEgj2ksqnyUsuXC+qLkVypGmwjrgh1JC6ZefVP+rvsidDnZsAw8uWgX0XRGvdSVfAMunise2kcZaefdgHvx3-M2v6fmTjRNgg..\\",\\"Status\\":0}}"ventGroupId\\":\\t1,\\n\\t\\"EventType\\":\\t103,\\n\\t\\"CallbackTs\\":\\t1615554923704,\\n\\t\\"EventInfo\\":\\t{\\n\\t\\t\\"RoomId\\":\\t12345,\\n\\t\\t\\"EventTs\\":\\t1608441737,\\n\\t\\t\\"UserId\\":\\t\\"test\\",\\n\\t\\t\\"UniqueId\\":\\t1615554922656,\\n\\t\\t\\"Role\\":\\t20,\\n\\t\\t\\"Reason\\":\\t1\\n\\t}\\n}"

    签名校验示例

    Java
    Python
    PHP
    Golang
    import javax.crypto.Mac;
    import javax.crypto.spec.SecretKeySpec;
    import java.util.Base64;
    //# 功能:第三方回调sign校验
    //# 参数:
    //# key:控制台配置的密钥key
    //# body:腾讯云回调返回的body体
    //# sign:腾讯云回调返回的签名值sign
    //# 返回值:
    //# Status:OK 表示校验通过,FAIL 表示校验失败,具体原因参考Info
    //# Info:成功/失败信息
    
    public class checkSign {
    public static String getResultSign(String key, String body) throws Exception {
    Mac hmacSha256 = Mac.getInstance("HmacSHA256");
    SecretKeySpec secret_key = new SecretKeySpec(key.getBytes(), "HmacSHA256");
    hmacSha256.init(secret_key);
    return Base64.getEncoder().encodeToString(hmacSha256.doFinal(body.getBytes()));
    }
    public static void main(String[] args) throws Exception {
    String key = "123654";
    String body = "{\\n" + "\\t\\"EventGroupId\\":\\t2,\\n" + "\\t\\"EventType\\":\\t204,\\n" + "\\t\\"CallbackTs\\":\\t1664209748188,\\n" + "\\t\\"EventInfo\\":\\t{\\n" + "\\t\\t\\"RoomId\\":\\t8489,\\n" + "\\t\\t\\"EventTs\\":\\t1664209748,\\n" + "\\t\\t\\"EventMsTs\\":\\t1664209748180,\\n" + "\\t\\t\\"UserId\\":\\t\\"user_85034614\\",\\n" + "\\t\\t\\"Reason\\":\\t0\\n" + "\\t}\\n" + "}";
    String Sign = "kkoFeO3Oh2ZHnjtg8tEAQhtXK16/KI05W3BQff8IvGA=";
    String resultSign = getResultSign(key, body);
    
    if (resultSign.equals(Sign)) {
    System.out.println("{'Status': 'OK', 'Info': '校验通过'}");
    } else {
    System.out.println("{'Status': 'FAIL', 'Info': '校验失败'}");
    }
    }
    }
    # -*- coding: utf8 -*-
    import hmac
    import base64
    from hashlib import sha256
    
    # 功能:第三方回调sign校验
    # 参数:
    # key:控制台配置的密钥key
    # body:腾讯云回调返回的body体
    # sign:腾讯云回调返回的签名值sign
    # 返回值:
    # Status:OK 表示校验通过,FAIL 表示校验失败,具体原因参考Info
    # Info:成功/失败信息
    
    def checkSign(key, body, sign):
    temp_dict = {}
    computSign = base64.b64encode(hmac.new(key.encode('utf-8'), body.encode('utf-8'), digestmod=sha256).digest()).decode('utf-8')
    print(computSign)
    if computSign == sign:
    temp_dict['Status'] = 'OK'
    temp_dict['Info'] = '校验通过'
    return temp_dict
    else:
    temp_dict['Status'] = 'FAIL'
    temp_dict['Info'] = '校验失败'
    return temp_dict
    
    if __name__ == '__main__':
    key = '123654'
    body = "{\\n" + "\\t\\"EventGroupId\\":\\t2,\\n" + "\\t\\"EventType\\":\\t204,\\n" + "\\t\\"CallbackTs\\":\\t1664209748188,\\n" + "\\t\\"EventInfo\\":\\t{\\n" + "\\t\\t\\"RoomId\\":\\t8489,\\n" + "\\t\\t\\"EventTs\\":\\t1664209748,\\n" + "\\t\\t\\"EventMsTs\\":\\t1664209748180,\\n" + "\\t\\t\\"UserId\\":\\t\\"user_85034614\\",\\n" + "\\t\\t\\"Reason\\":\\t0\\n" + "\\t}\\n" + "}"
    sign = 'kkoFeO3Oh2ZHnjtg8tEAQhtXK16/KI05W3BQff8IvGA='
    result = checkSign(key, body, sign)
    print(result)
    <?php
    
    class TlsEventSig {
    private $key = false;
    private $body = false;
    public function __construct( $key, $body ) {
    $this->key = $key;
    $this->body = $body;
    }
    
    private function __hmacsha256() {
    $hash = hash_hmac( 'sha256', $this->body, $this->key, true );
    return base64_encode( $hash);
    }
    public function genEventSig() {
    return $this->__hmacsha256();
    }
    }
    
    $key="789";
    $data="{\\n\\t\\"EventGroupId\\":\\t1,\\n\\t\\"EventType\\":\\t101,\\n\\t\\"CallbackTs\\":\\t1608086882372,\\n\\t\\"EventInfo\\":\\t{\\n\\t\\t\\"RoomId\\":\\t20222,\\n\\t\\t\\"EventTs\\":\\t1608086882,\\n\\t\\t\\"UserId\\":\\t\\"222222_phone\\"\\n\\t}\\n}";
    
    $api = new TlsEventSig($key, $data);
    echo $api->genEventSig();
    package main
    import "fmt"
    import (
    "crypto/hmac"
    "crypto/sha256"
    "encoding/base64"
    )
    
    func main () {
    var data = "{\\n\\t\\"EventGroupId\\":\\t1,\\n\\t\\"EventType\\":\\t101,\\n\\t\\"CallbackTs\\":\\t1608086882372,\\n\\t\\"EventInfo\\":\\t{\\n\\t\\t\\"RoomId\\":\\t20222,\\n\\t\\t\\"EventTs\\":\\t1608086882,\\n\\t\\t\\"UserId\\":\\t\\"222222_phone\\"\\n\\t}\\n}"
    var key = "789"
    
    //JSRUN引擎2.0,支持多达30种语言在线运行,全仿真在线交互输入输出。
    fmt.Println(hmacsha256(data,key))
    }
    
    func hmacsha256(data string, key string) string {
    h := hmac.New(sha256.New, []byte(key))
    h.Write([]byte(data))
    return base64.StdEncoding.EncodeToString(h.Sum(nil))
    }
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持