创建云 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。
trunkConfigurationAccess 否 String 是否允许 PBX 用户在 PBX 上添加和导入中继。
注：
  • 你具有为云 PBX 配置 中继配置权限 的权限，否则此设置不生效。
  • 此设置仅在 P 系列云 PBX 的固件为 84.21.0.66 或更高版本时生效。
取值范围：
  • Enabled：启用
  • Disabled：禁用
autoActivated 否 Boolean 是否自动激活云 PBX。
注： 此设置仅在云 PBX 的固件为 84.21.0.66 时生效。
有效值：
  • true：启用。创建云 PBX 后自动激活。
  • false：禁用。 (默认值)
cloudPbxInitialConfigRequest 否 Object<Initial_Config> 云 PBX 的初始化配置。
注：
  • 此参数在 autoActivated 设为 true 时必填。
  • 此设置仅在云 PBX 的固件为 84.21.0.66 时生效。
Trunk_DID_Relation
参数 是否必填 类型 说明
trunkId 是 Integer 共享中继的 ID。
注： 可使用 查询可用共享中继 查询中继 ID。
didIds 是 Array <Integer> DID 号码的 ID 列表。
注： 可使用 查询指定中继可用的 DID 号码 查询 DID 号码 ID。
Initial_Config
参数 是否必填 类型 说明
administratorSettings 是 Object<Admin_Settings> PBX 超级管理员账户信息。
dateAndTimeSettings 是 Object<Date_Time> PBX 系统的日期与时间设置。
localization 是 Object<Local_Setting> PBX 本地化设置。
Admin_Settings
参数 是否必填 类型 说明
username 是 String 用于登录 PBX 管理网页的用户名。
注：
  • 长度至少为 6 个字符。
  • 用户名必须包含大写字母和小写字母。
  • 不允许使用特殊字符 @。
newPassword 是 String 用于登录 PBX 管理网页的密码。
注：
  • 长度至少为 10 个字符。
  • 密码必须包含大写字母、小写字母和数字。
  • 不允许出现 4 个及以上的重复或连续数字。
confirmPassword 是 String 重复密码以确认。
emailAddress 是 String 超级管理员的邮箱地址。
prefix 否 String 拨号前缀。
若设置了此项，则系统要通过呼叫手机以向超级管理员通知系统事件时，将自动在手机号码前加上此前缀进行拨打。
注： 系统初始化完成后，你需要在 PBX 上创建拨号规则匹配此前缀的呼出路由，确保系统可成功呼出。
mobileNumber 否 String 用于接收系统通知的手机号码。
注：
  • 此参数在 enableMobileNotify 设为 Enabled 时必填。
  • 长度不得超过 31 个字符。
enableEventNotify 否 String 是否向 PBX 超级管理员发送事件通知。
取值范围：
  • Enabled：启用。
  • Disabled：禁用。
contactName 否 String 接收事件通知的联系人姓名。
注： 此参数在 enableEventNotify 设为 Enabled 时必填。
notificationLevel 否 String 按严重级别筛选事件通知。
注：
  • 此参数在 enableEventNotify 设为 Enabled 时必填。
  • 可指定多个级别，以空格分隔 (如 "error warn")。
取值范围：
  • error：需要立即处理的严重警报。
  • warn：表示非理想状态的警告，可能会导致错误的事件。
  • info：一般消息通知。
enableEmailNotify 否 String 是否通过邮件向联系人发送系统事件通知。
注： enableEventNotify 设为 Enabled 时，enableEmailNotify 和 enableMobileNotify 二者必启用一项。
取值范围：
  • Enabled：启用
  • Disabled：禁用
enableMobileNotify 否 String 是否通过拨打手机号码向联系人发送系统事件通知。
注： enableEventNotify 设为 Enabled 时，enableEmailNotify 和 enableMobileNotify 二者必启用一项。
取值范围：
  • Enabled：启用
  • Disabled：禁用
Date_Time
参数 是否必填 类型 说明
timeZone 是 String PBX 系统所使用的默认时区。
注： 具体可用参数值请参见 PBX 创建参数值参考 - 时区。
enableDst 是 String 是否启用夏令时 (DST)。
取值范围：
  • Enabled：启用。
  • Disabled：禁用。
dateFormat 是 String 系统中日期的显示格式。
取值范围：
  • yyyy/mm/dd：年/月/日
  • mm/dd/yyyy：月/日/年
  • dd/mm/yyyy：日/月/年
timeFormat 是 String 系统中时间的显示格式。
取值范围：
  • 12-hour：12 小时制
  • 24-hour：24 小时制
Local_Settings
参数 是否必填 类型 说明
systemPromptLanguage 是 String 系统语音提示的默认语言。
注： 具体可用参数值请参见 PBX 创建参数值参考 - 提示音。
emailLanguage 是 String 系统生成的通知邮件所使用的语言。
注： 具体可用参数值请参见 PBX 创建参数值参考 - 邮件通知语言。
deviceName 是 String PBX 系统的设备名称。
nameDisplayFormat 是 String 用户和联系人姓名的显示格式。
取值范围：
  • first_last：{名称} {姓氏} (中间有空格)
  • first_last：{姓氏} {名称} (中间有空格)
  • lastfirst：{姓氏}{名称} (中间无空格)
toneRegion 是 String 指定你所在的国家或地区，系统将采用该区域的标准信号音 (包括拨号音、忙音、回铃音)。
注： 具体可用参数值请参见 PBX 创建参数值参考 - 信号音。
enbCountryCode 是 String 决定是否限制用户拨打国际电话。
取值范围：
  • Enabled：启用
  • Disabled：禁用
dialCode 否 String 指定一个自定义前缀，用于在 PBX 内识别国际呼叫。

当用户拨打的号码以此前缀为开头时，PBX 会将其视为国际呼叫。

注： 此参数在 enbCountryCode 设为 Enabled 时必填。

响应参数

参数 类型 说明
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,
  "autoActivated":"true",
  "cloudPbxInitialConfigRequest":{
    "administratorSettings":{
        "username":"PBXadmin1",
        "newPassword":"Yeastar202",
        "confirmPassword":"Yeastar202",
        "emailAddress":"evelynhong@yeastar.com",
        "prefix":"123",
        "mobileNumber":"123456789",
        "enableEventNotify":"Enabled",
        "contactName":"Evelynhong",
        "notificationLevel":"warn info error",
        "enableEmailNotify":"Enabled",
        "enableMobileNotify":"Enabled"

    },
    "dateAndTimeSettings":{
        "timeZone":"UTC+8 Asia/Shanghai",
        "enableDst":"Enabled",
        "dateFormat":"yyyy/mm/dd",
        "timeFormat":"24-hour"

    },
    "localization":{
        "systemPromptLanguage":"sound-en",
        "emailLanguage":"en",
        "deviceName":"API Test",
        "nameDisplayFormat":"first_last",
        "toneRegion":"us",
        "enbCountryCode":"Enabled",
        "dialCode":"123"

    }
  }
}
响应示例
HTTP/1.1 200 OK
{
  "data": {
    "cloudPbxId": 42100
  },
  "requestId": "44151421047434e0ef817a10fc5331a5",
  "status": "Success",
  "time": 1664450755
}