/
IPTV v1

IPTV v1

2019-09-03


THIS API IS NOT LIVE

This document describes system integration API between TableCheck and an IPTV system. The document assumes the IPTV has implemented the frontend interface described in the following section.

1.1      Conventions and Notes

  • All UI designs, mocks, etc. are for illustration purposes only and are not intended to be implemented literally by the IPTV system provider.
  • The term “Franchise” used in the API shall mean “Hotel Property”
  • The term “Shop” used in the API shall mean “Restaurant”


Target audience

The IPTV API is recommended for use by:

  • In-room IPTV systems
  • Digital signage and hospitality kiosks

The Directory API is not intended for use by Point-of-Sale, CRM, or IPTV vendors. Instead, a listing of shops will be 



CMS Onboarding Workflow

  1. TS Support Team (support@tablesolution.com) enables the franchise and provides the “Franchise ID” for hotel.
  2. Using Franchise ID CMS pulls restaurant static data from TS API
  3. Hotel Content Manager can override the data in the CMS as necessary
  4. CMS provides data to IPTV system.


User (Guest) Workflow

  1. IPTV “Home” screen contains navigation elements to direct user to “Restaurant Selection” screen.
  2. IPTV “Restaurant Selection” allows user to select restaurant for booking.
  3. After restaurant selected, IPTV allows user to select booking pattern,
  4. Booking patterns (refer to following sections for details)
  1. Receive SMS to book via mobile web
  2. Book via IPTV user interface


1.1      UI Mock: CMS Franchise (Hotel) Config Screen

* Illustration for conceptual purposes only; design to be decided by IPTV vendor.

1.1      UI Mock: CMS Shop (Restaurant) Config Screen

* Illustration for conceptual purposes only; design to be decided by IPTV vendor.

1.1      UI Mock: IPTV Restaurant Selection Screen

* Illustration for conceptual purposes only; design to be decided by IPTV vendor.




Workflow Pattern A: “Book via SMS”


By design, the "Book via IPTV" workflow has severe feature limitations versus booking by SMS (web), for example, end users are unable to preorder courses or make online payments. As a result, many outlets may wish to only use the "Book via SMS" workflow.

Therefore, the "Book via IPTV" option should be made configurable (on/off) per each outlet in your CMS.



  1. User selects “restaurant”, then enters “date”, “time”, “party size” into the IPTV user interface.
  2. IPTV system checks availability of reservation.
  3. If unavailable, IPTV system displays message, including alternate recommendations.
  4. If available, IPTV attempts to create reservation.
  5. If reservation failed,
  6. User receives SMS and email

Related content