API Integration


Hi All

I am working on a project to provide iPBx’s and phones into three luxury cruise liners. The iPBX’s need to be able to integrate with both the infotainment system, and the guest experience system. So, for example, cabin 22 is assigned to Mr & Mrs Jones. This information is pulled from the guest experience system, so when Mr & Mrs Jones arrive at their cabin, there is a message on the phone saying “Welcome Mr & Mrs Jones”.

Similarly, if Mrs Jones phones home and the call costs $120.00, that CDR needs to be pushed to (or pulled into) the guest epxerience portal, so that all additional charges can be viewed.

I’m guessing this is fairly standard ‘hotel’ type stuff, but it is new to me; where do I start please?!


ucm 6xxx crm integration - pms system application programming


There are several aspects to consider, with the first being the interface of how the phone system is made aware of the check in/out function for the guests. As Kev points out this is typically accomplished by a property management system (PMS) which should have a telephony interface/protocol. There are a many different PMS protocols out there and you need to find out which one is in use so you can understand the capabilities, the command set and the interface type - serial, TCP/IP or ?

The PBX system may or may not do call cost accounting. Those that support some form of standalone hotel operations (meaning no PMS) generally do have a rudimentary costing capability, but many PBX systems to include the UCM do not have internal pricing functionality. In this case the CDR or SMDR records are passed from the PBX to a 3rd party call accounting system that parses the data, determines local, long distance, international, and other call types and may or may not price the call, but will at least pass the info to the PMS which may price the call.

As far as generating a message for a display, you will need to see the PMS routines for check-in and then have a middle ware or other to see the check-in message that can then generate the API command to send a text, if such an API into the UCM exists (Never checked). Of course, doing that may also trigger the phone into a mode that allows the guests to reply.

So, find out the PMS and then check the PBX API to see if the text is supported.


If you go with android phones (GXV) then message can be incorparted directly with externall system (app ?).
As @lpneblett pointed to much depend on 3rd party systems and what they can do or what kind of integration you need.

You a even use GSC3570 station as helper in addition to simple phone.


Thanks to all. No doubt I’ll be back in time…


Alright, thanks mate, even my doubts about api integration is now cleared.


Can GrantElliot, hope youre doing well, can you also help me with api integration, it would grateful to you. Thanks


Thank you. Your example didn’t work for me but I managed to fix it, which was basically the same thing!



Integrating iPBX systems and phones into luxury cruise liners for guest services is indeed a specialized project that involves various components and considerations. While it shares similarities with hotel telecommunication systems, the unique environment of a cruise liner introduces some distinct challenges. Here’s a step-by-step guide to help you get started:

  1. Project Planning and Requirements Gathering: Begin by thoroughly understanding the specific requirements and expectations of the cruise liner and its guests. This includes determining the scale of the project, the number of cabins, types of services required (telephony, messaging, billing integration), and any regulatory or compliance considerations.
  2. Select the Right iPBX Solution: Research and choose an iPBX solution that meets the cruise liner’s requirements. Look for a system that offers scalability, reliability, and the ability to integrate with other systems.
  3. Integrate with Infotainment and Guest Experience Systems: Collaborate with the cruise liner’s IT and engineering teams to ensure seamless integration between the iPBX system and the infotainment and guest experience systems. This may require custom development or middleware solutions to exchange data between these systems.
  4. Guest Account Management: Implement a system for managing guest accounts and profiles. When guests check in, their information should be automatically synchronized between systems, allowing personalized greetings and services.
  5. Billing and Call Detail Records (CDR): Integrate the iPBX system with the cruise liner’s billing and accounting systems. Ensure that call detail records (CDRs) are generated for all calls, and these records are accurately transferred to the billing system for guest charges.
  6. Quality of Service (QoS): Implement Quality of Service (QoS) measures to ensure voice calls have priority on the network to maintain call quality, especially in a potentially congested environment like a cruise liner.
  7. Security and Compliance: Pay close attention to security and compliance requirements, especially if you are dealing with sensitive guest data and financial transactions. Implement encryption and other security measures as needed.
  8. Training and Support: Provide training to cruise liner staff responsible for managing and maintaining the iPBX system. Ensure that they can troubleshoot common issues and perform routine maintenance.
  9. Testing and Validation: Thoroughly test the integrated system in a controlled environment before deployment. This includes testing for call quality, data synchronization, billing accuracy, and other critical functions.
  10. Deployment and Ongoing Support: Deploy the iPBX systems and phones in the cruise liners. Be prepared to offer ongoing support and maintenance to ensure the system continues to function smoothly.
  11. Documentation: Maintain comprehensive documentation of the system’s architecture, configurations, and integrations for future reference and troubleshooting.
  12. Feedback and Improvement: Continuously gather feedback from guests and staff to identify areas for improvement and enhancement of services.

It’s essential to work closely with the cruise liner’s IT and operational teams throughout the project. Consider engaging with specialized consultants or vendors experienced in cruise liner telecommunication systems to ensure a successful implementation. Additionally, be prepared for potential challenges related to the unique environment of a moving ship, such as satellite connectivity issues and power management. PayByPlateMa


Good read, thank you. I spent 7 years at sea myself with Princess Cruises. My daugheter just came back from norwegian cruise line, and they use Mitel systems