创建云 PBX

创建云 PBX。

请求 URL

POST {base_url}/dm/open_api/v1/cloud_pbx/instances

请求参数

请求头
参数 是否必填 类型 说明
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。
请求体
参数 是否必填 类型 说明
name 是 String PBX 名称。
plan 是 String PBX 订阅服务。

取值范围：

  • Enterprise Plan：企业版
  • Ultimate Plan：旗舰版
extensionCapacity 是 Long 云 PBX 的分机数。
concurrentCallCapacity 是 Long 云 PBX 的并发数。
recordingStatus 是 String 是否启用云 PBX 的通话录音功能。
取值范围：
  • Enabled：启用
  • Disabled：禁用
recordingCapacity 是 Long 通话录音分钟数。
注： 如果此参数设置为 0，则云 PBX 的通话录音功能会被禁用。
transcriptionCapacity 否 Long 额外分配给云 PBX 的 AI 语音转写分钟数 (不含 PBX 订阅服务中已包含的时长)。
注：
  • 此参数仅在云 PBX 的固件版本为 84.19.0.110 或更高版本时生效。
  • 企业版 包含 120 分钟，旗舰版 包含 240 分钟。
  • 若无需额外的 AI 语音转写时长，可将该值设置为 0，或不传递该参数。
regionId 是 Integer 云 PBX 所在区域的 ID。
注： 可使用 查询可用区域 接口查询区域 ID。
subDomain 是 String 云 PBX 的子域名。
注：
  • 云 PBX 的 URL 由自定义的子域名和指定的域名组成。
  • 此参数中仅允许填写数字、大小写字母以及连字符 -。
domainId 是 Integer 所需域名的 ID。
注： 可使用 查询可用域名 接口查询域名 ID。
versionId 是 Integer PBX 固件版本的 ID。
注： 可使用 查询可用固件版本 接口查询固件版本 ID。
type 是 String PBX 类型。

取值范围：

  • Trial：试用
  • Commercial：商用
expirationDate 否 Long PBX 过期时间。
注： 在此字段中填写 PBX 过期时间的时间戳。
allowRunAfterExpirationDate 否 Boolean 是否允许 PBX 在过期时间后仍可用。
取值范围：
  • true：允许
  • false：不允许
注： 此参数在设置了 expirationDate 参数时必填。
customerIds 是 Array <Long> 与云 PBX 关联的客户的 ID。
注：
trunkDidRelations 否 Array <Trunk_DID_Relation> 要分配给云 PBX 的 DID 号码及其关联的共享中继的对应关系列表。
注： 此参数仅在云 PBX 固件为 84.19.0.22 或更高版本时生效。
upgradeInPbx 是 String 是否允许从 PBX 端升级。
取值范围：
  • Enabled：启用
  • Disabled：禁用
im 是 String 是否启用 PBX 的聊天 (IM) 功能。
注： 可应用此设置的 P 系列云 PBX 固件版本为 84.12.0.32 或更高。
取值范围：
  • Enabled：启用
  • Disabled：禁用
pbxApi 否 String 是否启用云 PBX 的 API 功能。
取值范围：
  • Enabled：启用
  • Disabled：禁用
passwordlessLogin 是 String 是否允许免密登录云 PBX。
取值范围：
  • Enabled：启用
  • Disabled：禁用
allowSuperiorPasswordlessLogin 是 String 是否允许你的上级账号从他的Yeastar 统一管理平台上免密登录此云 PBX。
注： 此参数的设置仅在 passwordlessLogin 设置为 Enabled 时生效。
取值范围：
  • Enabled：启用
  • Disabled：禁用
provisioningViaTemplate 否 String 是否允许使用模板配置云 PBX。
取值范围：
  • Enabled：启用
  • Disabled：禁用
provisionTemplateId 否 Integer 配置模板的唯一 ID。
注： 可使用 查询所有配置模板 接口查询配置模板 ID。
Trunk_DID_Relation
参数 是否必填 类型 说明
trunkId 是 Integer 共享中继的 ID。
注： 可使用 查询所有共享中继 查询中继 ID。
didIds 是 Array <Integer> DID 号码的 ID 列表。
注： 可使用 查询所有 DID 号码 查询 DID 号码 ID。

响应参数

参数 类型 说明
data Object <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 说明
cloudPbxId Long 云 PBX 的 ID。

示例

请求示例

创建一台云 PBX：
  • URL：cloud.test4.yeastarcloud.com；
  • 区域：Asia Pacific(Singapore) (ID：4)；
  • 域名：test4.yeastarcloud.com (ID：4)；
  • 固件：84.8.0.25 (ID：764)。
POST /dm/open_api/v1/cloud_pbx/instances HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ0NTAxOTh9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NDUxOTk4LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJmNzAzYjk0Ni1kMzk4LTQxZWEtOTgwZi1hOGZmNWYxODhiNDAiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.N9R6s5ttSah3LRdDBowQYdYw8URWhzyJYiD5cdVm2ZM
Content-Type: application/json
{
  "name": "Yeastar P-Series Cloud PBX",
  "plan": "Enterprise Plan",
  "extensionCapacity": 20,
  "concurrentCallCapacity": 10,
  "recordingStatus": "Enabled",
  "recordingCapacity": 500,
  "transcriptionCapacity":0,
  "regionId": 4,
  "subDomain": "cloud",
  "domainId": 4,
  "type": "Commercial",
  "expirationDate": 1667059200,
  "allowRunAfterExpirationDate":false,
  "versionId": 764,
  "customerIds": [50086182,50429564],
  "upgradeInPbx": "Enabled",
  "im": "Enabled",
  "pbxApi": "Enabled",
  "passwordlessLogin": "Enabled",
  "allowSuperiorPasswordlessLogin": "Enabled",
  "provisioningViaTemplate":"Enabled",
  "provisionTemplateId":306
}
响应示例
HTTP/1.1 200 OK
{
  "data": {
    "cloudPbxId": 42100
  },
  "requestId": "44151421047434e0ef817a10fc5331a5",
  "status": "Success",
  "time": 1664450755
}