响应结果
YCM API 以 JSON 格式返回响应结果。
正常响应示例
正常响应的 HTTP 状态码为 200。
正常的响应结果包含以下参数:
参数 | 类型 | 描述 |
---|---|---|
data | Object | 响应数据详情。 |
requestId | String | 请求 ID,作为该请求的唯一标识,用于快速定位请求。 |
status | String | 请求结果。
|
time | Long | 请求响应的时间。 注: YCM API
响应返回的是时间戳,如有需要,你可以将时间戳转换成具体的日期和时间。详细操作方法,请参见 将时间戳转换为日期和时间。
|
正常响应示例
查询所有云 PBX。
HTTP/1.1 200 OK
{
"data": {
"pageSize": 1,
"pageNumber": 1,
"total": 221,
"list": [
{
"cloudPbxId": 7715,
"pbxStatus": "Running",
"activationStatus": "Activated",
"name": "Yeastar P-Series Cloud PBX",
"sn": "3658B4311196XXXX",
"plan": "Enterprise Plan",
"planExpirationDate": 1667035676,
"extensionCapacity": 20,
"concurrentCallCapacity": 5,
"recordingStatus": "Enabled",
"recordingCapacity": 500,
"region": "China(Guangdong)",
"url": "cloud.example.yeastar.com",
"type": "Commercial",
"version": "84.8.0.25",
"creator":
{
"firstName": "Leo",
"lastName": "Ball",
"email": "leo@yeastar.com"
},
"creatorRole": "Super Administrator",
"createTime": 1635737324,
"upgradeInPbx": "Enabled",
"passwordlessLogin": "Disabled"
}
]
},
"requestId": "5ed01d8b-44f2-44a7-a868-2c7ba3a090d4",
"status": "Success",
"time": 1639012740
}
异常响应示例
异常响应结果包含以下参数:
参数 | 类型 | 描述 |
---|---|---|
requestId | String | 请求 ID,作为该请求的唯一标识,用于快速定位请求,排查问题。 |
Status | String | 请求结果。
|
time | Long | 请求响应的时间。 注: YCM API
响应返回的是时间戳,如有需要,你可以将时间戳转换成具体的日期和时间。详细操作方法,请参见 将时间戳转换为日期和时间。
|
errCode | Integer | 错误码。有关具体信息,请参见 错误码。 |
errMsg | String | 错误信息。 |
异常响应示例
{
"errCode": 1000035,
"errMsg": "TOKEN_EXPIRED",
"requestId": "6f221147-367d-4fcd-b919-8ba0c9074372",
"status": "Failed",
"time": 1638860250
}