API 列表

xiaodian.vxlive.status

  • 免费
  • 无需授权

API功能描述(支持get和post)

获取店铺vxlive的直播状态，是否有直播，如果有返回配置的直播图片

公共参数

名称 类型 必选 描述
app_key Long 是 接入时申请的app_key
method String 是 接口名称
access_token String 是 Oauth2.0授权获得的access_token
sign String 是 对 API 调用参数（除sign外）进行 md5 加密获得。参数的顺序为字母表的顺序
timestamp Long 是 时间戳，使用Unix时间戳格式
format String 是 响应格式。默认为json格式，固定
sign_method String 否 参数的加密方法选择，当前只支持Md5
version String 否 API协议版本，固定值为：1.0

输入参数

名称 类型 必选 描述 示例值

返回参数

名称 类型 描述 默认值
path String 小程序直播路径
isLive Boolean 是否正在直播
icon String 直播配置主图
title String 直播标题
liveId Number 直播id
liveStatus Number 直播状态(0未开始,1正在直播,2已结束)
roomId Number 房间Id
previewDate String 预告时间

请求参数示例

1).
{ }

返回示例

1).
{
    "status":{
        "code":"0000000",
        "msg":"操作成功"
    },
    "result":{
        "data":{
            "isPublish":true,
            "path":"pages/live/normal/index",
            "isLive":true,
            "subscribeNum":67,
            "icon":"http://s11.mogucdn.com/mlcdn/c45406/190912_5h1g7gl4707e68684lh5dc87f6a98_1290x1032.png",
            "title":"OBS直播",
            "liveId":2512403,
            "liveStatus":1,
            "roomId":3103
        }
    },
    "success":true
}
2).
{
    "status":{
        "code":"0000000",
        "msg":"操作成功"
    },
    "result":{
        "data":{
            "isPublish":true,
            "path":"pages/live/normal/index",
            "isLive":false,
            "liveStatus":2
        }
    },
    "success":true
}
3).
{
    "status":{
        "code":"0000000",
        "msg":"操作成功"
    },
    "result":{
        "data":{
            "isPublish":true,
            "path":"pages/live/normal/index",
            "isLive":false,
            "previewDate":"今天20:10:50开始",
            "subscribeNum":67,
"icon":"http://s11.mogucdn.com/mlcdn/c45406/190912_5h1g7gl4707e68684lh5dc87f6a98_1290x1032.png",
            "title":"预告直播测试",
            "liveId":2534801,
            "liveStatus":0,
            "roomId":3107
        }
    },
    "success":true
}

4).
{"result":{"data":{"isPublish":false}},"success":true,"status":{"msg":"操作成功","code":"0000000"}}

异常示例

1).
{
	"status": {
		"code": "1000500",
		"msg": "查询不到店铺信息"
	},
	"result": {
		"data": {}
	},
	"success": false
}

API测试工具