You need to enable JavaScript to run this app.
导航

获取业务标识 GetAllBusinessID

最近更新时间2024.02.29 19:30:24

首次发布时间2022.09.20 15:07:37

如果你已创建业务标识,你可以查询指定 AppID 下所有业务标识的相关信息。你可以使用 GetAllBusinessID 这个 OpenAPI 实现这一功能。

使用说明

接口行为

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

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构,参看调用方法

注意事项

请求频率:QPS 不超过 20

请求说明

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

请求参数

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

Query

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

Body

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

返回参数

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

参数
类型
示例值
描述
BusinessRecords
Object
业务标识相关信息
AppId
String
Your_AppId
应用的唯一标识
BusinessId
String
Your_BusinessId
业务 ID
Remarks
String
Your_Remarks
业务名称
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": "Your_AppId",
    "Offset": "Your_Offset",
    "Limit": "Your_Limit"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "GetAllBusinessID",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-01"
    },
    "Result": {
        "BusinessRecords": {
            "AppId": "Your_AppId",
            "BusinessId": "Your_BusinessId",
            "Remarks": "Your_Remarks",
            "CreatedTime": "2022-09-15T15:16:37+08:00"
        },
        "TotalSize": 1
    }
}

错误码

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