Auto Provision Flat-phone with Yeastar P-Series Software Edition
This topic takes Flat-phone B10 (firmware: 15.66.7.12.234) as an example to describe how to auto provision Flat-phone with Yeastar P-Series Software Edition.
Requirements
The firmwares of Flat-phone and Yeastar PBX meet the following requirements.
| Model | Phone Requirement | PBX Requirement | Supported Auto Provisioning Method |
|---|---|---|---|
| B6 | 15.63.11.12.234 or later | 83.19.0.110 or later |
|
| B10 | 15.66.7.12.234 or later | 83.19.0.110 or later |
|
| C10 | 15.60.11.12.234 or later | 83.19.0.110 or later |
|
Scenarios
The provisioning methods and operations vary depending on the network environment of Flat-phone and Yeastar PBX, as the following table shows.
| Scenario | Description |
|---|---|
| IP Phone and PBX are in the SAME subnet | In this scenario, you can provision the Flat-phone with the
PBX via PnP method. For more information, see Auto provision a Flat-phone in the same subnet (PnP). |
| IP Phone and PBX are in DIFFERENT subnets | In this scenario, you can provision the Flat-phone with the
PBX via DHCP method. For more information, see Auto provision a Flat-phone in different subnets (DHCP). |
| IP Phone and PBX are in DIFFERENT networks | In this scenario, you can provision the Flat-phone with
Yeastar PBX via Provision Link method. For more information, see Provision a Flat-phone in different networks (Provision Link). |
Auto provision a Flat-phone in the same subnet (PnP)
In this example, the Flat-phone (IP: 192.168.28.205) and the Yeastar
PBX (IP: 192.168.28.39) are both deployed in subnet 28.

- Prerequisites
-
- Make sure that you have downloaded the template for the desired phone model (Path: ).
- If the IP phone is previously used, you need to RESET the IP phone, then re-configure the network settings for the phone.
- Procedure
-
- Log in to PBX web portal, go to .
The IP phones detected by the PBX via PnP are displayed in the phone list.
- Click
beside the Flat-phone.
- Optional: In the Options
section, select a desired template from the
Template drop-down list.Note: You can select the default template corresponding to the phone model, or customize your own template. For more information, see Create a Custom Auto Provisioning Template.
- In the Assign Extension
section, assign extension(s) to the phone, then specify which
extension's phonebook and function keys you want to use on the
phone.Tip: If your desired extension is not listed in the drop-down list of the Extension column, it indicates that the devices registered to the extension has reached the limit. You can use either of the following methods to proceed.
- To release the extension from the associated IP phone or gateway, see Release an Extension from a Provisioned IP Phone/Gateway.
- To raise the phone registration limit, you need to configure the concurrent registration setting for the extension, as the PBX only allows an extension to register with one SIP endpoint by default.
- To assign a single extension to the phone, select a desired
extension from the drop-down list beside
SIP1.
Both the Phonebook Line and Function Key Line fields are set to SIP1 by default, indicating that the phone will use the authorized phonebook(s) and function keys of the extension assigned to the SIP line 1.

- To assign multiple extensions to the phone, complete the
following settings.

- In the drop-down list beside SIP1, select a desired extension for SIP line 1.
- Click Add, then select a
desired SIP line and an extension for the added
entry.To assign more extensions to the phone, repeat this step.Note: The selected SIP lines must be supported by the phone, otherwise the configurations for unsupported SIP line will not be applied. You can check the phone's supported SIP lines via the phone webpage or on the device screen.
- In the Phonebook Line
drop-down list, select a SIP line. The phone book of
extension assigned to the SIP line will be applied
to the phone.Note: After successful registration, contacts are available regardless of which SIP line is currently active on the phone.
- In the Function Key Line
drop-down list, select a SIP line. The function keys
of extension assigned to the SIP line will be
applied to the phone.Note: After successful registration, the function keys take effect only when the selected SIP line is active on the phone.
- Click Save.
- Log in to PBX web portal, go to .
- Result
-
Note: Some IP phones will reboot automatically. If not, you need to manually reboot the phone to make the configurations take effect.
Auto provision a Flat-phone in different subnets (DHCP)
In this example, the Flat-phone and DHCP server are deployed in subnet 20, while the
Yeastar PBX (IP: 192.168.28.110) is deployed in subnet 28.

- Prerequisites
-
- Make sure that there is only one DHCP server running in the subnet where the IP phone is deployed, or the IP phone would fail to obtain an IP address.
- Make sure that the IP phone and PBX can communicate with each other over the subnets.
- Make sure that you have downloaded the template for the desired phone model (Path: ).
- RESET the IP phone if it is previously used.
- Gather information of IP phone, including Vendor, Model, and MAC address.
- Procedure
- Step 1. Enable Remote Registration feature for the extension on PBX
- Enable the Remote Registration feature for the extension to be assigned to the phone, so that the extension can be registered in a different subnet.
- Step 2. Add the Flat-phone on the PBX
-
Add the IP phone on PBX. The PBX will generate a configuration file based on the phone's MAC address.
- On PBX web portal, go to .
- Click .
- In the IP Phone section, configure
phone information as follows:

- Vendor: Select Flat-Phone.
- Model: Select a phone model. In this example, select B10.
- MAC Address: Enter the MAC address of the IP phone.
- In the Options section, configure the
following settings.

- Template: Select a desired
template from the drop-down list.Note: You can select the default template corresponding to the phone model, or customize your own template. For more information, see Create a Custom Auto Provisioning Template.
- Provisioning Method: Select
DHCP (In the Office).
A provisioning link is automatically generated and displayed in the Provisioning Link field. This provisioning link points to the location where the phone's configuration file is stored.
- Template: Select a desired
template from the drop-down list.
- In the Assign Extension
section, assign extension(s) to the phone, then specify which
extension's phonebook and function keys you want to use on the
phone.Tip: If your desired extension is not listed in the drop-down list of the Extension column, it indicates that the devices registered to the extension has reached the limit. You can use either of the following methods to proceed.
- To release the extension from the associated IP phone or gateway, see Release an Extension from a Provisioned IP Phone/Gateway.
- To raise the phone registration limit, you need to configure the concurrent registration setting for the extension, as the PBX only allows an extension to register with one SIP endpoint by default.
- To assign a single extension to the phone, select a desired
extension from the drop-down list beside
SIP1.
Both the Phonebook Line and Function Key Line fields are set to SIP1 by default, indicating that the phone will use the authorized phonebook(s) and function keys of the extension assigned to the SIP line 1.

- To assign multiple extensions to the phone, complete the
following settings.

- In the drop-down list beside SIP1, select a desired extension for SIP line 1.
- Click Add, then select a
desired SIP line and an extension for the added
entry.To assign more extensions to the phone, repeat this step.Note: The selected SIP lines must be supported by the phone, otherwise the configurations for unsupported SIP line will not be applied. You can check the phone's supported SIP lines via the phone webpage or on the device screen.
- In the Phonebook Line
drop-down list, select a SIP line. The phone book of
extension assigned to the SIP line will be applied
to the phone.Note: After successful registration, contacts are available regardless of which SIP line is currently active on the phone.
- In the Function Key Line
drop-down list, select a SIP line. The function keys
of extension assigned to the SIP line will be
applied to the phone.Note: After successful registration, the function keys take effect only when the selected SIP line is active on the phone.
- Click Save.
- Step 3. Configure DHCP option 66 on DHCP server
-
In the subnet where the IP phone is deployed, use the generated provisioning link to configure option 66 on the DHCP Server.
- On PBX web portal, copy the provisioning link from the phone's
detail page.

- On the DHCP server, set up option 66 with the provisioning
link.
In this example, the configuration is shown below.

- On PBX web portal, copy the provisioning link from the phone's
detail page.
- Result
-
Note: Some IP phones will reboot automatically. If not, you need to manually reboot the phone to make the configurations take effect.
- After the IP phone is rebooted, it gets an IP address from the DHCP server, downloads the configurations from the PBX via the provisioning link, and applies the settings automatically.
- The extension is successfully registered on the IP phone. You can
check the registration status on on the PBX web portal.
Note: If the status displays
, this indicates that you assigned
multiple extensions to the IP phone but only some of them are
successfully registered on the phone. You can hover over
to view the registration status of
each extension.
- If multiple extensions are
successfully registered on the phone, corresponding SIP lines are
associated with different physical line keys on the device.
You can press a line key to activate the target SIP line. The corresponding indicator LED illuminates, and all calls are processed over this SIP line.
Provision a Flat-phone in different networks (Provision Link)
- Prerequisites
-
- Set up a DHCP server in the same subnet as the IP phone to
assign it an IP address.Note: Make sure that there is only one DHCP server running in the subnet, or the IP phone would fail to obtain an IP address.
- Make sure that you have downloaded the template for the desired phone model (Path: ).
- Make sure that you have completed the corresponding settings
shown below according to the network environment of
Flat-phone and Yeastar PBX.
Method Setting Using Yeastar FQDN -
Subscribe to Enterprise Plan or Ultimate Plan for the PBX and ensure the FQDN is available.
-
Grant remote access permission for extension to be registered and the remote IP phones:
- Grant remote SIP access permission for the
extension, so that the extension can be
registered remotely via FQDN (Path: ).

- If you have enabled IP restriction for Yeastar FQDN remote
Web access, make sure that you have added
the phone's IP address to the permitted IP list,
so that the phone can obtain configuration files
from the PBX (Path: ).

- Grant remote SIP access permission for the
extension, so that the extension can be
registered remotely via FQDN (Path: ).
- Make sure that you have downloaded the template for the desired phone model (Path: ).
- RESET the IP phone if it is previously used.
- Gather information of IP phone, including Vendor, Model, and MAC address.
Using Public IP address / external host / Yeastar domain name - Configure PBX network for remote access
by a public IP address, by an external host domain name, or by a Yeastar domain name.Important: The following PBX ports MUST be forwarded for RPS provisioning.
- RTP ports
- SIP port
- Web Server port
- Set up the extension for remote
registration.
- Enable
NAT
for the extension (Path: ).

- Enable Remote Registration feature for the extension
(Path: ).

- Enable
NAT
for the extension (Path: ).
- Make sure that you have downloaded the template for the desired phone model (Path: ).
- RESET the IP phone if it is previously used.
- Gather information of IP phone, including Vendor, Model, and MAC address.
-
- Set up a DHCP server in the same subnet as the IP phone to
assign it an IP address.
- Procedure
- Step 1. Add the Flat-phone on PBX
-
Add the IP phone on PBX. The PBX will generate a configuration file based on the phone's MAC address.
- Log in to PBX web portal, go to .
- Click .
- In the IP Phone section, configure
phone information as follows:

- Vendor: Select Flat-Phone.
- Model: Select a phone model. In this example, select B10.
- MAC Address: Enter the MAC address of the IP phone.
- In the Options section, configure the
following settings.

- Template: Select a desired
template from the drop-down list.Note: You can select the default template corresponding to the phone model, or customize your own template. For more information, see Create a Custom Auto Provisioning Template.
- Provisioning
Method: Select Provision Link
- FQDN (Remote) or Provision
Link (Remote).The Provisioning Link field displays a provisioning link, which points to the location where the phone's configuration file is stored.Note: Note down the provisioning link, as you will need to use it later when configuring the DHCP server.
- Template: Select a desired
template from the drop-down list.
- In the Assign Extension
section, assign extension(s) to the phone, then specify which
extension's phonebook and function keys you want to use on the
phone.Tip: If your desired extension is not listed in the drop-down list of the Extension column, it indicates that the devices registered to the extension has reached the limit. You can use either of the following methods to proceed.
- To release the extension from the associated IP phone or gateway, see Release an Extension from a Provisioned IP Phone/Gateway.
- To raise the phone registration limit, you need to configure the concurrent registration setting for the extension, as the PBX only allows an extension to register with one SIP endpoint by default.
- To assign a single extension to the phone, select a desired
extension from the drop-down list beside
SIP1.
Both the Phonebook Line and Function Key Line fields are set to SIP1 by default, indicating that the phone will use the authorized phonebook(s) and function keys of the extension assigned to the SIP line 1.

- To assign multiple extensions to the phone, complete the
following settings.

- In the drop-down list beside SIP1, select a desired extension for SIP line 1.
- Click Add, then select a
desired SIP line and an extension for the added
entry.To assign more extensions to the phone, repeat this step.Note: The selected SIP lines must be supported by the phone, otherwise the configurations for unsupported SIP line will not be applied. You can check the phone's supported SIP lines via the phone webpage or on the device screen.
- In the Phonebook Line
drop-down list, select a SIP line. The phone book of
extension assigned to the SIP line will be applied
to the phone.Note: After successful registration, contacts are available regardless of which SIP line is currently active on the phone.
- In the Function Key Line
drop-down list, select a SIP line. The function keys
of extension assigned to the SIP line will be
applied to the phone.Note: After successful registration, the function keys take effect only when the selected SIP line is active on the phone.
- Click Save.
- Step 2. Configure DHCP option 66 on DHCP server
- In the subnet where the IP phone is deployed, use the generated
provisioning link to configure option 66 on the DHCP Server.
- On PBX web portal, copy the provisioning link from the
phone's detail page.

- On the DHCP server, set up option 66 with the provisioning
link.
In this example, the configuration is shown below:

- On PBX web portal, copy the provisioning link from the
phone's detail page.
- Result
-
Note: Some IP phones will reboot automatically. If not, you need to manually reboot the phone to make the configurations take effect.
- After the IP phone is rebooted, it gets an IP address from the DHCP server, downloads the configurations from the PBX via the provisioning link, and applies the settings automatically.
- The extension is successfully registered on the IP phone. You can
check the registration status on on the PBX web portal.
Note: If the status displays
, this indicates that you assigned
multiple extensions to the IP phone but only some of them are
successfully registered on the phone. You can hover over
to view the registration status of
each extension.
- If multiple extensions are
successfully registered on the phone, corresponding SIP lines are
associated with different physical line keys on the device.
You can press a line key to activate the target SIP line. The corresponding indicator LED illuminates, and all calls are processed over this SIP line.
