查询 PBX 容量

查询 PBX 容量,包括分机数和通话并发数,以及 AI 转写和 AI 接待员功能的总容量与已使用容量。

请求 URL

GET {base_url}/{api_path}/system/capacity?access_token={access_token}

请求参数

无请求参数。直接发送请求 URL 查询 PBX 容量 。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。
data Object<Device_Capacity> PBX 容量。
Device_Capacity
1.
参数 类型 说明
extension_capacity Integer 最大分机数。
extension_used Integer 已使用的分机数。
cc_capacity Integer 最大通话并发数。
cc_used Integer 已使用的通话并发数。
ai_transcription_onetime_capacity Integer AI 转写一次性容量总量 (单位:秒)。
ai_transcription_onetime_used Integer AI 转写一次性容量已使用量 (单位:秒)。
ai_transcription_pack_capacity Integer AI 转写月容量包总量 (单位:秒)。
ai_transcription_pack_used Integer AI 转写月容量包当月已使用量 (单位:秒)。
ai_receptionist_onetime_capacity Integer AI 接待员一次性容量总量 (单位:秒)。
ai_receptionist_onetime_used Integer AI 接待员一次性容量已使用量 (单位:秒)。
ai_receptionist_pack_capacity Integer AI 接待员月容量包总量 (单位:秒)。
ai_receptionist_pack_used Integer AI 接待员月容量包当月已使用量 (单位:秒)。

示例

请求示例

GET /openapi/v1.0/system/capacity?access_token=tmZCgLHfy9a2qpFthxdGfa0Xr6v3D63C 

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "extension_capacity": 50,
        "extension_used": 10,
        "cc_capacity": 25,
        "cc_used": 0,
        "ai_transcription_onetime_capacity": 20400,
        "ai_transcription_onetime_used": 13115,
        "ai_transcription_pack_capacity": 30000,
        "ai_transcription_pack_used": 272,
        "ai_receptionist_onetime_capacity": 9600,
        "ai_receptionist_onetime_used": 69,
        "ai_receptionist_pack_capacity": 30000,
        "ai_receptionist_pack_used": 716
    }
}