激活 PBX 并完成初始配置

激活 Yeastar P 系列软件版 并完成初始配置。

注：
  • 仅支持在线激活。如需离线激活，请通过 PBX 网页中的安装向导完成激活和初始设置。
  • 要调用该接口，确保 PBX 的版本为 83.24.0.30 或更高。

请求 URL

POST {base_url}/{api_path}/wizard/initial_setup

请求参数

参数 是否必填 类型 说明
activation 是 Object<Activation_Setting> 激活设置。
administrator 是 Object<Administrator_Setting> 管理员账号设置。
network 否 Object<Network_Setting> 网络基本设置。
注： 对于部署在云平台上的 PBX，请跳过网络设置，否则可能导致 PBX 无法访问。
date_and_time 否 Object<DateTime_Setting> 日期和时间设置。
localization 否 Object<Localization_Setting> 本地化设置。
reboot 否 Boolean 激活成功后是否重启 PBX。
取值范围：
  • true
  • false
重要： 如果修改了网络设置或时间设置，需将此参数设置为 true，以便重启 PBX 并应用更改。
Activation_Setting
参数 是否必填 类型 说明
code 是 String 激活码。
Administrator_Setting
参数 是否必填 类型 说明
username 是 String 管理员用户名。
new_password 是 String 管理员密码，使用 Base64 编码。
注： Base64 解码后的明文密码长度至少为 10 个字符，并且必须包含至少一个大写字母、一个小写字母和一个数字。
confirm_password 是 String 用于确认管理员密码，必须与 new_password 完全一致。
email 是 String 管理员邮箱地址。
mobile 否 String 管理员手机号码。
dial_prefix 否 String 外呼拨号前缀。呼叫管理员手机号码时，系统会自动在号码前添加该前缀。
enable_event_notify 是 Integer 是否启用事件通知。

取值范围：

  • 0：禁用
  • 1：启用
注： 当设置为 1 时， event_contact_name 和 levels 必填；且 enable_email_notify 和 enable_mobile_notify 至少一个参数必须设置为 1。
event_contact_name 否 String 事件通知联系人名称。
levels 否 String 触发事件通知的事件级别。

取值范围：

  • error：异常
  • warn：警告
  • info：通知
注： 多个级别之间使用空格分隔。
enable_email_notify 否 Integer 是否发送事件通知到管理员邮箱地址。

取值范围：

  • 0：禁用
  • 1：启用
enable_mobile_notify 否 Integer 是否呼叫管理员手机号码以发送事件通知。

取值范围：

  • 0：禁用
  • 1：启用
注： 当设置为 1 时，mobile 必填。
Network_Setting
参数 是否必填 类型 说明
mode 是 String 网口模式。

取值范围：

  • single：单网卡。
  • dual：双网卡。
gwnic 是 String 默认网口。

取值范围：

  • eth0：LAN 口。
  • eth1：WAN 口。
注： 单网卡 模式下，仅支持使用 eth0；双网卡 模式下，可使用 eth0 或 eth1。
nic_setting_eth0 是 Object<LAN_Setting> LAN 网络设置。
nic_setting_eth1 否 Object<WAN Setting> WAN 网络设置。
LAN_Setting
参数 是否必填 类型 说明
protocol 是 String IP 协议。

取值范围：

  • ipv4：仅 IPv4。
  • ipv4+ipv6：IPv4 和 IPv6。
priority 是 String 首选 IP 协议。

取值范围：

  • ipv4：优先使用 IPv4。
  • ipv6：优先使用 IPv6。
IPv4 设置 (静态 IP)
ipaddress 是 String IPv4 地址。
netmask 是 String IPv4 子网掩码。
gateway 否 String IPv4 默认网关。
dns1 否 String 首选 IPv4 DNS 服务器。
dns2 否 String 次选 IPv4 DNS 服务器。
ipaddress2 否 String 第二个 IPv4 地址。
netmask2 否 String 第二个 IPv4 地址的子网掩码。
IPv6 设置 (静态 IP)
ipv6_ipaddress 否 String IPv6 地址。
注： 当 protocol 设置为 ipv4+ipv6 时必填。
ipv6_prefix_length 否 Integer IPv6 前缀长度。
注： 当 protocol 设置为 ipv4+ipv6 时必填。
ipv6_gateway 否 String IPv6 默认网关。
ipv6_dns1 否 String 首选 IPv6 DNS 服务器。
ipv6_dns2 否 String 次选 IPv6 DNS 服务器。
ipv6_ipaddress2 否 String 第二个 IPv6 地址。
ipv6_prefix_length2 否 Integer 第二个 IPv6 地址的前缀长度。
WAN Setting
参数 是否必填 类型 说明
protocol 是 String IP 协议。

取值范围：

  • ipv4：仅 IPv4。
  • ipv4+ipv6：IPv4 和 IPv6。
priority 是 String 首选 IP 协议。

取值范围：

  • ipv4：优先使用 IPv4。
  • ipv6：优先使用 IPv6。
IPv4 设置
type 是 String IP 地址分配方式。

取值范围：

  • dhcp：DHCP
  • staticip：静态 IP 地址
  • pppoe：PPPoE
IPv4 设置 (静态 IP)
ipaddress 否 String IPv4 地址。
注： 当 type 设置为 staticip 时必填。
netmask 否 String IPv4 子网掩码。
注： 当 type 设置为 staticip 时必填。
gateway 否 String IPv4 默认网关。
dns1 否 String 首选 IPv4 DNS 服务器。
dns2 否 String 次选 IPv4 DNS 服务器。
IPv4 设置 (PPPoE)
注： 以下参数在 type 设置为 pppoe 时必填。
pppoe_username 否 String PPPoE 用户名。
pppoe_password 否 String PPPoE 密码。
IPv6 设置
ipv6_type 否 String IPv6 地址分配方式。

取值范围：

  • dhcp：DHCP
  • staticip：静态 IP 地址
IPv6 设置 (静态 IP)
ipv6_ipaddress 否 String IPv6 地址。
注： 当 ipv6_type 设置为 staticip 时必填。
ipv6_prefix_length 否 Integer IPv6 前缀长度。
注： 当 ipv6_type 设置为 staticip 时必填。
ipv6_gateway 否 String IPv6 默认网关。
ipv6_dns1 否 String 首选 IPv6 DNS 服务器。
ipv6_dns2 否 String 次选 IPv6 DNS 服务器。
DateTime_Setting
参数 是否必填 类型 说明
timezone 是 String 时区值，包括 UTC 偏移量和时区标识符。
注： 有效值请参见 时区有效值。
date_format 是 String 日期显示格式。

取值范围：

  • mm/dd/yyyy：月/日/年
  • yyyy/mm/dd：年/月/日
  • dd/mm/yyyy：日/月/年
time_format 是 String 时间显示格式。

取值范围：

  • 24-hour：24 小时制
  • 12-hour：12 小时制
enable_dst 否 Integer 是否启用夏令时。

取值范围：

  • 0：禁用
  • 1：启用
enable_ntp 否 Integer 是否通过 NTP 服务器自动同步时间。

取值范围：

  • 0：禁用
  • 1：启用
注：
  • 当设置为 0 时， time_setting 必填。
  • 当设置为 1 时， ntp_server 必填。
ntp_server 否 String NTP 服务器地址。
time_setting 否 Object<Time_Setting> 手动设置的日期和时间。
Localization_Setting
参数 是否必填 类型 说明
system_prompt_language 否 String 系统提示音语言。
注： 有效值请参见 系统提示音语言有效值。
email_language 否 String 邮件通知语言。
注： 有效值请参见 邮件通知语言有效值。
dev_name 否 String 设备名称。
name_disp_fmt 否 String 联系人姓名显示格式。

取值范围：

  • first_last：名字在前，姓氏在后，中间含空格
  • last_first：姓氏在前，名字在后，中间含空格
  • lastfirst：姓氏在前，名字在后，中间无空格
tone_region 否 String 信号音。
注： 有效值请参见 信号音有效值。
enb_country_code 否 Integer 是否启用国家/地区号码呼叫防御。

取值范围：

  • 0：禁用
  • 1：启用
注： 当设置为 1 时， dialcode 必填。
dialcode 否 String 国际拨号代码。
Time_Setting
参数 是否必填 类型 说明
date 否 String 手动设置的日期，格式必须与 date_format 保持一致。

示例：

  • 当 date_format 为 yyyy/mm/dd 时，日期为 2025/12/30。
  • 当 date_format 为 mm/dd/yyyy时，日期为 12/30/2025。
  • 当 date_format 为 dd/mm/yyyy时，日期为 30/12/2025。
time 否 String 手动设置的时间，格式必须与 time_format 保持一致。
示例：
  • 当 time_format 为 24-hour 时，时间格式为 HH:MM 或 HH:MM:SS。

    例如 14:30 或 14:30:00。

  • 当 time_format 为 12-hour 时，时间格式为 HH:MM AM/PM 或 HH:MM:SS AM/PM。

    例如 02:30 PM 或 02:30:00 PM。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
activation_status String 激活状态。
  • subscribe：已订阅并完成激活。
  • subscribe_expired：订阅已过期。
  • trial：已试用并完成激活。
  • trial_expired：试用已过期。
api_client_id String 用于 OpenAPI 调用的 Client ID。
api_client_secret String 用于 OpenAPI 调用的 Client Secret。
注： 该参数值为 Base64 编码后的字符串，可通过 Base64 解码获取原始值。
expiration_date String 授权码到期日期。
max_concurrent_calls Integer PBX 支持的最大通话并发数。
max_extensions Integer PBX 支持的最大分机数量。

示例

请求示例

POST /openapi/v1.0/wizard/initial_setup HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json

{
    "activation": {
        "code": "8E4D-KSCR-IWCH-RKPT-6AMI"
    },
    "administrator": {
        "confirm_password": "WWVhc3RhcjIwMg==",
        "enable_event_notify": 1,
        "event_contact_name":"leo",
        "levels":"error warn",
        "enable_email_notify":1,
        "new_password": "WWVhc3RhcjIwMg==",
        "username": "admin",
        "email":"leo@yeastar.com"
    },
    "localization": {
        "system_prompt_language": "sound-en",
        "email_language": "en",
        "dev_name": "PSE",
        "name_disp_fmt": "first_last",
        "tone_region":"cn",
        "enb_country_code":0
     },
     "date_and_time": {
        "timezone": "UTC+8 Asia/Shanghai",
        "date_format":"yyyy/mm/dd",
        "time_format":"24-hour"
    },
    "network": {
        "mode": "single",
        "gwnic": "eth0",
        "nic_setting_eth0": {
            "protocol": "ipv4",
            "priority":"ipv4",
            "dns1": "8.8.8.8",
            "dns2": "114.114.114.114",
            "gateway": "10.10.28.1",
            "ipaddress": "10.10.28.45",           
            "netmask": "255.255.255.0"
        }
    },
    "reboot": true
}

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "activation_status": "subscribe",
    "expiration_date": "07/17/2027 02:44:43",
    "max_concurrent_calls": 1,
    "max_extensions": 3,
    "api_client_id": "k8Ad9uFX3z1MBJKmEKaHHarzYWiVjJGC",
    "api_client_secret": "NldDMXRuYXNNa3J5YXYyNEhQM0JBRDA0WVNoWWVaUEU="
}