获取业务标识 GetAllBusinessID--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

获取业务标识 GetAllBusinessID

最近更新时间：2024.10.14 17:25:23首次发布时间：2022.09.20 15:07:37

在实时音视频通话场景中，你可以通过调用此接口获取特定应用下所有业务标识的详细信息。

使用说明

接口行为

你可以调用GetAllBusinessID 这个 OpenAPI 获取指定 AppId 下所有业务标识的相关信息。

注意事项

请求频率：QPS 不超过 20。
该接口请求接入地址仅支持 rtc.volcengineapi.com。

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=GetAllBusinessID&Version=2020-12-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetAllBusinessID`	接口名称。当前 API 的名称为 `GetAllBusinessID`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppID	String	是	`661e****543cf`	应用的唯一标识
Offset	String	否	`100`	返回的业务标识上限。最大值为 `100`，默认值为 `100`。
Limit	String	否	`0`	偏移量，单位为条，默认值为 `0`。

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数	类型	示例值	描述
BusinessRecords	Object[]	`-`	业务标识相关信息
AppId	String	`661e****543cf`	应用的唯一标识
BusinessId	String	`B****23`	业务 ID
Remarks	String	`测试业务`	业务名称
CreatedTime	String	`2022-09-15T15:16:37+08:00`	该业务标识创建时间戳，格式为 RFC3339，单位为秒
TotalSize	Integer	`1`	该 AppId 下业务标识总数

请求示例

POST https://rtc.volcengineapi.com?Action=GetAllBusinessID&Version=2020-12-01
{
    "AppId": "661e****543cf",
    "Offset": "100",
    "Limit": "0"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "GetAllBusinessID",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-01"
    },
    "Result": {
        "BusinessRecords": {
            "AppId": "661e****543cf",
            "BusinessId": "B****23",
            "Remarks": "测试业务",
            "CreatedTime": "2022-09-15T15:16:37+08:00"
        },
        "TotalSize": 1
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。