查询直播信息

GET

/v1.0/live/lives

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口，根据直播ID查询直播信息。

调用本接口，根据直播ID，查询直播的详情信息，获取的部分直播信息如下图所示。

说明

本接口适用于直播的任意状态。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	钉钉直播获取数据读权限	API Explorer
第三方企业应用	支持	钉钉直播获取数据读权限	API Explorer
第三方个人应用	暂不支持	钉钉直播获取数据读权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	invalidParam	lippi_live.stream.paramError	参数错误，该直播不存在
500	serviceError	error:%s	系统服务错误

请求参数

Query 参数

Header 参数

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.dingtalk.com/v1.0/live/lives?liveId=String&unionId=String' \
--header 'x-acs-dingtalk-access-token;'

响应示例

{
    "result": {
        "liveInfo": {
            "liveId": "string",
            "unionId": "string",
            "title": "string",
            "coverUrl": "string",
            "startTime": 0,
            "endTime": 0,
            "introduction": "string",
            "liveStatus": 0,
            "duration": 0,
            "subscribeCount": 0,
            "uv": 0,
            "livePlayUrl": "string",
            "playbackDuration": 0
        }
    }
}

修改于 2024-01-16 08:07:13

删除直播

修改直播属性信息

查询直播信息

权限#

错误码#

请求参数

返回响应

权限

错误码