16F, D5, Tianfu Software Park, Chengdu, China(610041)
+86 (28)85337096 ext 813 / 815
zycoo@zycoo.com
CooVox T-Series IPPBX
PMS API Feature Guide
Support software version: v4.0.5 & above
Documentation version: v1.0
IPPBX PMS API Feature Guide
1
1. Settings
Log into the IPPBX web GUI, and go to Addons-->API-->PMS-->Settings.
Select the type of PMS API that the IPPBX is integrated with and you could change the
related parameter settings. IPPBX can support multiple types of PMS APIs. After the
customer selects the hotel API type, the page will display the corresponding settings.
Steps:
First select the "PMS API Type", fill in the API related parameters, select "Enable" and then
click "Submit".
The configuration parameters are described below:
Item
Instruction
PMS API Type
Select the API type of the hotel Property Management System that
needs to be integrated.
API Port
Select the API service port on the IPPBX side.
User Name
Username to authenticate API connections.
Password
Password to authenticate API connections.
Hotel ID
Identify specific hotels.
Enable
Whether to enable the API service.
Note: When the hotel API type selects "Other", the system will open a TCP Socket-based API
service for connecting to the hotel management system. After opening, the system will listen
to port 8080.
IPPBX PMS API Feature Guide
2
2. Room Status
Log into the IPPBX web GUI, and go to Addons-->API-->PMS-->Room Status.
The corresponding list of extension numbers and room numbers in the IPPBX system. It is
used to display the check-in information of the hotel rooms and the related information of the
guests.
Steps：
First click "Add" button to select the extension number corresponding to the hotel room
which is used as the guest room extension.
After the addition is completed, the hotel room information can be modified through the
"Edit" and "Delete" buttons on the IPPBX page, and the hotel room data can also be operated
through the API of the hotel management system.
Use the extension of the current room to dial *56 function key to set the status of the room,
and you can also dial *056 function key to clear all current settings.
IPPBX PMS API Feature Guide
3
The configuration parameters are described below:
Item
Instruction
Room Number
Specify a specific hotel room number.
Room Status
Set the room status as check in or check out.
Guest Name
The name of the customer in the room.
VIP Level
Check-in room customer VIP level.
Language
The language type of the guest in the room.
Checkin Time
The customer's check-in time.
Checkout Time
The customer's check-out time.
Note: The room status code needs to be defined in the hotel PMS. Use the guest room
extension to dial the room status code and then input the corresponding status code
according to the voice prompt.
IPPBX PMS API Feature Guide
4
3. Wake Up Call
Log into the IPPBX web GUI, and go to Addons-->API-->PMS-->Wake Up Call.
The wake up service is the same as Telephony-->Advancned Featur es-->Wake Up Call in
the PBX.
The Default Prompts file is the voice file that will be played by default when the wake-up call
is answered. After uploading the file in Telephony-->Audio Library-->Other Custom
Pr ompts, you can find it in the drop-down options, select the file and click "Submit".
Select the wake up call voice file in the "Default Prompts" drop-down options and click
"Submit".
Click the "Add" button to add a wake up call, you can select multiple extensions at the same
time, set the "Wake Up Time", "Extension Number" and "Voice Prompt", click "Submit".
IPPBX PMS API Feature Guide
5
The configuration parameters are described below.
Item
Instruction
Extension Number
Set the extension number for wake up service.
Wake Up Time
The time when to dial the wake up call.
Executing Status
Whether the wake up call has already performed a dial operation.
Wake Up Call Status
Whether the wake up call is answered.
Voice Prompt
Set the voice file to be played after the wake up call is answered.
Default Prompts
Set the global default voice prompt file, if not set, the built-in voice
file of the system will be used.
IPPBX PMS API Feature Guide
6
4. MiniBar
Log into the IPPBX web GUI, and go to Addons-->API-->PMS-->MiniBar.
The MiniBar is used for billing statistics of consumer goods in the hotel room, and the
attendant can dial the MiniBar code through the guest room phone to add or delete the
consumer goods. Optional goods in MiniBar can only be added through the web management
page.
Steps:
Click "Add MiniBar", enter "MiniBar Code", "Name" and "Authentication" and click
IPPBX PMS API Feature Guide
7
"Submit".
The attendant dials the MiniBar code through the extension and enters the Attendant ID to
enter the MiniBar to manage the billing of the consumer goods. If "Authentication" is
enabled, you need to enter the attendant password before dialing the MiniBar code to enter.
The attendant information is set in Addons-API-PMS-Attendant
The configuration parameters are described below.
Item
Instruction
MiniBar Code
The code of the MiniBar, the attendant can use the room extension to dial
this code to enter the MiniBar.
Name
The name of the MiniBar.
Authentication
Whether the attendant needs to enter the verification code before enter the
MiniBar code to enter.
Consumer item management in MiniBar
The configuration parameters are described below.
Item
Instruction
Code
Item code, the attendant need to input the code corresponding to the
item when billing the consumption item in the room.
Name
The name of the consumer goods.
IPPBX PMS API Feature Guide
8
5. Attendant
Log into the IPPBX web GUI, and go to Addons-->API-->PMS-->Attendant.
Attendant is an account consisting of attendant number and password used to manage room
billing in MiniBar. After the attendant uses the extension to dial the MiniBar code, these
information will be needed.
Steps:
Click "Add" and enter "ID" and "Password" and click "Submit".
The configuration parameters are described below.
Item
Instruction
ID
The ID used by housekeeping staff to access the MiniBar.
Password
The password used by housekeeping staff to access the MiniBar.
IPPBX PMS API Feature Guide
9
/
