延时直播服务接口-OPENAPI

鉴权说明

1、访问域名 https://openapi.aodianyun.com/apaas/v4/toollcps/apiPath //注意apiPath 是具体接口名称（见下文）

2、必须参数（utf-8编码）：
①、X-AccessId: 系统分配的访问者身份标识
②、X-TimeStamp：时间戳，是1970年一月一日0点到当前的秒数。用于本服务端当前时间比较，超过某一个值后就要返回过期失败。
③、X-SignatureNonce:随机数，请求时候尽量不要重复，最次要10分钟内不要重复。
④、X-Signature:签名，用于验证请求合法性。文后讲签名生成规则。

3、 签名规则（signature计算方式）
①、组织明文签名串stringToSign，按如下格式拼接待签名字符串：

stringToSign=    X-AccessId+"\n"+     //注意 \n 是换行 参数之间用换行符连接 生成得到 stringToSign    X-AccessKey+"\n"+    X-SignatureNonce+"\n"+    X-TimeStamp+"\n"+    body   //注意POST请求body（json格式）参数也一定要加入到签名规则内一同生成stringToSign

②签名密文生成

X-Signature=md5(stringToSign),其中md5是去32位小写。 //将上面stringToSign进行md5得到X-Signature

4、请求示例

curl -X POST https://openapi.aodianyun.com/apaas/v4/toollcps/createProject-H "X-AccessId:id11111" -H "X-Signature:a589810bd181755176f93fc202511218"   -H "X-TimeStamp:1539084154" -H "X-SignatureNonce:a234567"-d '{"user":1233,"age":88,"name":"Tom"}'

一、创建工程

请求URL：https://openapi.aodianyun.com/apaas/v4/toollcps/CreateToolProject
请求方式：POST

body输入参数

输出参数

返回具体参数格式

{    
    "flag": 100,    
    "flagString": "操作成功",    
    "Info": {        
        "id": 3660  //工程id（唯一标识）    
        }
 }

二、开启工程

请求URL：https://openapi.aodianyun.com/apaas/v4/toollcps/OpenToolLcps
请求方式：POST

body输入参数

输出参数

返回具体参数格式

{
    "flag": 100,
    "flagString": "success",
    "data": {
        "projectId": 1298,//工程id
        "instanceID": "lfq7ap3y",//导播台实例id（唯一）
        "domain": "igll9r13",//导播台域名
        "sourceNum": 4,//信道数
        "outputResolution": "720P",导播台分辨率
        "destroyTime": 1679887158,//工程到期时间
        "upTime": 1679887158,//工程开启时间
        "secretKey": "f8873fc4daaafbfa8c53e0bc3178b31b",//工程密钥
        "pageUrl": "//cdn.jstest.aodianyun.cn/lcps_delay/apaas/index.html#/director?id=1298&secretKey=f8873fc4daaafbfa8c53e0bc3178b31b"//延迟导播工程操作地址
    }
}

三、关闭工程

请求URL：https://openapi.aodianyun.com/apaas/v4/toollcps/RemoveTool
请求方式：POST

body输入参数

输出参数

返回具体参数格式

{    
    "flag": 100,    
    "flagString": "success"
}

四、删除工程

请求URL：https://openapi.aodianyun.com/apaas/v4/toollcps/DelTool
请求方式：POST

body输入参数

输出参数

返回具体参数格式

{    
    "flag": 100,    
    "flagString": "success"
}

五、延期工程

请求URL：https://openapi.aodianyun.com/apaas/v4/toollcps/DelayTool
请求方式：POST

body输入参数

输出参数

返回具体参数格式

{
    "flag": 100,
    "flagString": "延期成功",
    "data": 1679888910//工程到期时间（时间戳秒）
}

六、获取活跃工程

请求URL：https://openapi.aodianyun.com/apaas/v4/toollcps/GetActiveToolList
请求方式：POST

body输入参数

输出参数

返回具体参数格式

{
    "flag": 100,
    "flagString": "查询成功",
    "list": [
        {
            "id": 1064,//工程id
            "domain": "iel5l3pd",导播台域名
            "uin": "1011",用户uin
            "title": "28测试",工程标题
            "sourceNum": 4,
            "outputResolution": "720P",//分辨率
            "instanceID": "lf0t4zjb",//底层导播实例id
            "lcpsMssApp": "",
            "lcpsMaxVideoSize": "720p",
            "channels": 1,
            "useHours": 1,//使用时长 小时
            "makeLcpsEnvConfig": "{\"Cha8"duration\":500,\"name\":\"无效果\"}}",
            "upTime": 1678347902,
            "expireTime": 1678351722,//过期时间
            "status": 0,
            "mcs_config": "",
            "sportsSub": "",
            "templetId": 0,
            "bindTool": 0,
            "lpsUrl": null,
            "isLive": 1,//底层导播实例存活状态 1存活  2销毁
            "pwd": "",
            "pwdStatus": 0,
            "webRtcKey": null,
            "type": 2,
            "initConfig": "eyJ1c2VWZXJzaW9uIjo0LCJjcHVDb3VuZhbHmZhbHNlfSwibGNwc1N5bmMiOltdfQ==",//导播台配置
            "timeType": 0,
            "mpcStatus": 0,
            "extendStatus": 0,//是否开启扩展工程 1开启  0关闭
            "extendUrl": "",//延迟导播页面地址
            "extendProjectId": 2//延迟导播工程id
        }
    ]
}

七、获取工程信息

请求URL：https://openapi.aodianyun.com/apaas/v4/toollcps/GetLcpsToolInfo
请求方式：POST

body输入参数

输出参数

返回具体参数格式

{
    "flag": 100,
    "flagString": "查询成功",
    "info": {
        "id": 1221,
        "domain": "icqsskvu",
        "uin": "1011",
        "title": "xym",
        "sourceNum": 4,
        "outputResolution": "720P",
        "instanceID": "lfhnnfck",
        "lcpsMssApp": "",
        "lcpsMaxVideoSize": "720p",
        "channels": 1,
        "useHours": 1,
        "makeLcpsEnvConfig": "{\"Channce\"}",
        "upTime": 1679367397,
        "expireTime": 1679370430,
        "status": 0,
        "mcs_config": "",
        "sportsSub": "",
        "templetId": 0,
        "bindTool": 0,
        "lpsUrl": null,
        "isLive": 2,//底层导播台状态 1开启 2关闭  (确定工程是否运行)
        "pwd": "",
        "pwdStatus": 0,
        "webRtcKey": null,
        "type": 2,
        "initConfig": "ey=",
        "timeType": 0,
        "mpcStatus": 0,
        "extendStatus": 0,//是否开启扩展工程  1开启  0关闭
        "extendUrl": "//cdn.jstest.aodianyun.cn/lcps_delay/apaas/index.html#/director?id=1222&subToken=617a416facf9f198aec08a0b1341b438&userCode=70Z3lN92A9a9qAWa6H",//扩展工程页面操作地址
        "extendProjectId": 2618,//扩展工程id
        "progress": 0//开启进度
    }
}

八、修改导播台配置（输出地址、输出启用开关）

请求URL：https://openapi.aodianyun.com/apaas/v4/toollcps/DelayChangeOutput
请求方式：POST

body输入参数

输出参数

返回具体参数格式

{    
    "flag": 100,    
    "flagString": "success"
}