{"type":"doc","content":[{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"paragraph","content":[{"text":"This page contains detailed information about the PBX and Call Accounting (CA) interfaces and messages.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"At this time Voiceware only support ","type":"text"},{"text":"Serial","type":"text","marks":[{"type":"strong"}]},{"text":" and ","type":"text"},{"text":"TCP/IP","type":"text","marks":[{"type":"strong"}]},{"text":" communication. An ","type":"text"},{"text":"API ","type":"text","marks":[{"type":"strong"}]},{"text":"interface is under development.","type":"text"}]}]}]},{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"panel","attrs":{"panelColor":"#DEEBFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Psip Version: 2.113","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Call Accounting","type":"text"}]},{"type":"paragraph","content":[{"text":"Voiceware can connect to many different call accounting (CA) systems. Below is a description of the default HOBIS format. Some PMS vendors use the HOBIS method, while others have their own format. Use whatever protocol file best matches the PMS that is being interfaced with or HOBIS if there is no match found.","type":"text"}]},{"type":"paragraph","content":[{"text":"Following that there is a listing of all additional parameters that can be added to the CA interface to alter how data is sent to the PMS system.","type":"text"}]},{"type":"expand","attrs":{"title":"HOBIS"},"content":[{"type":"paragraph","content":[{"text":"This Interface Protocol is based on the original AT&T* HOBIS-to-PMS Interface and is employed by more than 90% of Property Management Systems.","type":"text"}]},{"type":"paragraph","content":[{"text":"With this protocol, records are sent in a typical Enquire-Acknowledge format (sometimes called ACK-NAK), with XOR checksum, as follows:","type":"text"}]},{"type":"paragraph","content":[{"text":"Phonesuite sends","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"PMS responds","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Where:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" is the enquire character (05 hex, 5 decimal)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" is the acknowledge character (06 hex, 6 decimal)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" is the start-of-text character (02 hex, 2 decimal)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" is an ASCII text string with data about a single call","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" is the end-of-text character (03 hex, 3 decimal)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" is the XOR checksum of all characters in plus (but not ).","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"If the PMS does not reply with the character when expected or replies with some other character (such as , 15 hex, 21 decimal), the send will be re-attempted after a short 1-3 second delay; the total number of attempts is normally three but can be changed using the additional parameters box.","type":"text"}]},{"type":"paragraph","content":[{"text":"If the PMS does not reply to all attempts an event message (“NO RESPONSE FROM PMS”) will be sent to the email address listed in the Settings page item 27.","type":"text"}]},{"type":"paragraph","content":[{"text":"In the HOBIS Interface Protocol, the ASCII text string () is sent in the following format:","type":"text"}]},{"type":"codeBlock","content":[{"text":" 1 2 3 4 5\n12345678901234567890123456789012345678901234567890123456\nCCCC PPP MM/DD EEEE HH:MM MMMM $DDD.CC NNNNNNNNNNNN D","type":"text"}]},{"type":"paragraph","content":[{"text":"Where the fields are:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"892037c3-9ce4-4ada-ade8-f9460a08fca2"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"Field","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[125.0]},"content":[{"type":"paragraph","content":[{"text":"Field Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[95.0]},"content":[{"type":"paragraph","content":[{"text":"Width","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"Default Position","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[239.0]},"content":[{"type":"paragraph","content":[{"text":"Empty Spaces Filled With","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"CCCC","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[125.0]},"content":[{"type":"paragraph","content":[{"text":"Counter","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[95.0]},"content":[{"type":"paragraph","content":[{"text":"04","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"01","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[239.0]},"content":[{"type":"paragraph","content":[{"text":"0 (in front of the digits)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"PPP","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[125.0]},"content":[{"type":"paragraph","content":[{"text":"Property Code","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[95.0]},"content":[{"type":"paragraph","content":[{"text":"03","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"06","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[239.0]},"content":[{"type":"paragraph","content":[{"text":"As in call accounting option 41","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"MM/DD","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[125.0]},"content":[{"type":"paragraph","content":[{"text":"Date","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[95.0]},"content":[{"type":"paragraph","content":[{"text":"05","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"10","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[239.0]},"content":[{"type":"paragraph","content":[{"text":"0 (in front of any single digit)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"EEEE","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[125.0]},"content":[{"type":"paragraph","content":[{"text":"Extension","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[95.0]},"content":[{"type":"paragraph","content":[{"text":"04","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"17","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[239.0]},"content":[{"type":"paragraph","content":[{"text":"Space (in front of the digits)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"HH:MM","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[125.0]},"content":[{"type":"paragraph","content":[{"text":"Time","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[95.0]},"content":[{"type":"paragraph","content":[{"text":"05","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"22","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[239.0]},"content":[{"type":"paragraph","content":[{"text":"0 (in front of any single digit)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"MMMM","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[125.0]},"content":[{"type":"paragraph","content":[{"text":"Duration","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[95.0]},"content":[{"type":"paragraph","content":[{"text":"04","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"28","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[239.0]},"content":[{"type":"paragraph","content":[{"text":"0 (in front of the digits)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"$DDD.CC","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[125.0]},"content":[{"type":"paragraph","content":[{"text":"Cost","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[95.0]},"content":[{"type":"paragraph","content":[{"text":"07","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"33","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[239.0]},"content":[{"type":"paragraph","content":[{"text":"0 (in any empty space after $)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"NNNNNNNNNNNN","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[125.0]},"content":[{"type":"paragraph","content":[{"text":"Number Dialed","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[95.0]},"content":[{"type":"paragraph","content":[{"text":"12","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"41","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[239.0]},"content":[{"type":"paragraph","content":[{"text":"Space (after the digits)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"D","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[125.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[95.0]},"content":[{"type":"paragraph","content":[{"text":"1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"54","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[239.0]},"content":[{"type":"paragraph","content":[{"text":"Space (if no description)","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Default Position shows the location of the first character in the field (the left edge of the field).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The counter field, CCCC, is a numeric counter in the first 3 positions, followed immediately (no space) by the letter A. When the counter “rolls over” to 000, the letter is incremented to B, and so on.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Duration field is minutes only, 0 padded on the left, rounded up to the nearest whole minute.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Cost field includes the dollar sign as part of that field.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Description field is one character only and is taken from the “PMS Interface” field in the Rate Line (call accounting option 21).","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Sample Data using the HOBIS Interface Protocol:","type":"text","marks":[{"type":"strong"}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":573,"id":"275848e7-239b-40b4-ad50-0e23efc0d649","collection":"contentId-21692417","type":"file","height":112}}]},{"type":"paragraph","content":[{"text":"Note: The column number ruler shown above the sample data does not print; it is included as an aid in determining where each field starts and ends.","type":"text"}]}]},{"type":"expand","attrs":{"title":"Micros"},"content":[{"type":"paragraph","content":[{"text":"This Interface Protocol is based on the specification for input to a MICROS cash register/POS system, circa 1980s.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"With this protocol, records are sent as follows:","type":"text"}]},{"type":"paragraph","content":[{"text":"Phonesuite sends","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"PMS responds","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Where:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" is the carriage return character (0D hex, 13 decimal)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" is an ASCII text string with data about a single call","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"If the PMS does not reply with “ACK” when expected, the send will be re-attempted after a short 1-3 second delay; the total number of attempts is set within the protocol file and can be changed using the additional parameters box.","type":"text"}]},{"type":"paragraph","content":[{"text":"If the PMS does not reply to all attempts, an event message (“NO RESPONSE FROM PMS”) will be sent to the email address listed in the Settings page item 27.","type":"text"}]},{"type":"paragraph","content":[{"text":"In the Micros Interface Protocol, the ASCII text string () is sent in the following format:","type":"text"}]},{"type":"paragraph","content":[{"text":"ac01 EEEE DDDDCC NNNNNNNNNN","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Where the fields are:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"37822df3-a385-401a-8c62-7a9a737abe6a"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[148.0]},"content":[{"type":"paragraph","content":[{"text":"Field","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[146.0]},"content":[{"type":"paragraph","content":[{"text":"Field Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[86.0]},"content":[{"type":"paragraph","content":[{"text":"Width","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[144.0]},"content":[{"type":"paragraph","content":[{"text":"Default Position","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"Empty Spaces Filled With","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[148.0]},"content":[{"type":"paragraph","content":[{"text":"ac01","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[146.0]},"content":[{"type":"paragraph","content":[{"text":"Start","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[86.0]},"content":[{"type":"paragraph","content":[{"text":"04","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[144.0]},"content":[{"type":"paragraph","content":[{"text":"01","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"N/A","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[148.0]},"content":[{"type":"paragraph","content":[{"text":"EEEE","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[146.0]},"content":[{"type":"paragraph","content":[{"text":"Extension","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[86.0]},"content":[{"type":"paragraph","content":[{"text":"04","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[144.0]},"content":[{"type":"paragraph","content":[{"text":"06","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"0 (in front of the digits)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[148.0]},"content":[{"type":"paragraph","content":[{"text":"DDDDCC","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[146.0]},"content":[{"type":"paragraph","content":[{"text":"Cost","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[86.0]},"content":[{"type":"paragraph","content":[{"text":"06","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[144.0]},"content":[{"type":"paragraph","content":[{"text":"11","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"0 (in front of the digits)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[148.0]},"content":[{"type":"paragraph","content":[{"text":"NNNNNNNNNN","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[146.0]},"content":[{"type":"paragraph","content":[{"text":"Number Dialed","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[86.0]},"content":[{"type":"paragraph","content":[{"text":"12","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[144.0]},"content":[{"type":"paragraph","content":[{"text":"18","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"0 (in front of the digits)","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Default Position shows the location of the first character in the field (the left edge of the field).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Start field is a fixed field that literally contains “ac01” every time. This was defined and set by Micros in the design of their interface.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"All fields are padded with “0” on the left side, including the Number Dialed field. The Number Dialed field is cut off at 10 characters, so only the first 10 digits dialed will be included for each call (including the initial “1” or “011” dialed); this means that longer phone numbers will lose the last digits dialed, while shorter phone numbers will have extra 0’s in front of the dialed digits.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The cost field is in dollars and cents and does not include a dollar sign.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Sample Data using the Micros Interface Protocol:","type":"text","marks":[{"type":"strong"}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":290,"id":"d6f68678-306c-4aa3-82e5-2c4cf251c6d4","collection":"contentId-21692417","type":"file","height":104}}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"The column number ruler shown above the sample data does not print; it is included as an aid in determining where each field starts and ends.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"PBX Interface","type":"text"}]},{"type":"paragraph","content":[{"text":"Voiceware is capable of both accepting command functions—such as check in, check out, message waiting lamp control, and others from a Property Management System (PMS)—and sending status messages back.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"The PBX Interface includes a voicemail interface. Some vendors have a separate voicemail interface, in Voiceware they are combined.","type":"text"}]}]},{"type":"expand","attrs":{"title":"Basic Message Format"},"content":[{"type":"paragraph","content":[{"text":"Phonesuite will interface with the PMS using the following Enquire-Acknowledge (sometimes called ACK-NAK) protocol:","type":"text"}]},{"type":"paragraph","content":[{"text":"Sender","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Receiver","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"},{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Where:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Sender can be either Phonesuite or the PMS, and Receiver is the other side.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" is the enquire character (005 ASCII)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" is the acknowledge character (006 ASCII)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" is the start-of-text character (002 ASCII)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" is the ASCII text string that contains the command, room status code, or other information as described below, with an optional Checksum","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" is the end-of-text character (003 ASCII).","type":"text"}]}]}]},{"type":"paragraph"},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the PMS sends an initial and Phonesuite responds with but does not receive any additional information within 1/10 second, Phonesuite times out this transaction without sending any further response. If additional data follows after this time-out (other than another ), Phonesuite will send a in response.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Phonesuite will send a character (021 ASCII) in any of the following cases:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"There is no at the end of the message, within 1/10 second of the last character received. ","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Phonesuite will ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"only ","type":"text","marks":[{"type":"em"}]},{"text":"send an in response to a from the PMS if","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Phonesuite receives the within 1/10 second of sending its in response to the PMS’s ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"and ","type":"text","marks":[{"type":"em"}]},{"text":"the is followed by within 1/10 second","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Any between-character delay of more than 1/10 second will cause the transaction to time out, and Phonesuite will send a (unless nothing followed the original ).","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Extension number padding","type":"text"}]},{"type":"paragraph","content":[{"text":"By default, Phonesuite will support a one-space padding between the end of the message field and the extension number as well as a trailing space for both 3- and 4-digit extensions.","type":"text"}]},{"type":"paragraph","content":[{"text":"Check In/Out Commands are sent from the PMS to Phonesuite and will cause Phonesuite to check a room in or out, the same as it does when the command is run from the Browser Console. For the PMS Check In/Out commands, Phonesuite will accept any of the below formats.","type":"text"}]}]},{"type":"expand","attrs":{"title":"Check in/Out"},"content":[{"type":"table","attrs":{"layout":"default","localId":"6ad58217-a858-48ff-bdbe-d9476cfc69c4"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Action Phonesuite takes in response","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"1234567890123456","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"CHK1 EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Check in extension EEEE; see note #1","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"CHK1 EEEE Name","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Check in extension EEEE with name; see note #2","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"CHK0 EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Check out extension EEEE; see note #1","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For 3-digit extensions, the extension number the PMS sends can be either right-justified or left-justified within the 4-character EEEE space. Phonesuite will send a in response to a Check-In or Check-Out Command that does not contain a valid extension number.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the PMS includes a name after the command the name can be any length up to a maximum 20 characters, in upper, lower, or mixed case. It can be in the form LAST,FIRST (comma delimiter only), or LAST, FIRST (both comma and space delimiter), or FIRST LAST (space only delimiter signifies first name, then last name), or LAST/FIRST (slash delimiter). Names can also be sent FIRST LAST using all delimiter types.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Note that a space is necessary between the CHK1 or CHK0 command and the extension number.","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Credit Limit"},"content":[{"type":"paragraph","content":[{"text":"A credit limit can be set by the PMS system for guests. For these messages, Phonesuite will format the message text as follows:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"07aa6e22-8fe4-4fd9-ae78-e516183572d2"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"1234567890123456","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"LMT EEE dd.cc","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Set a credit limit of for dd.cc room EEE","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"LMT EEEE $dd.cc","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Set a credit limit of dd.cc for room EEEE","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"The credit limit amount can start with a dollar sign ($) but this is not required and should be omitted if possible. Credit limit of up to 999.99 can be set.","type":"text"}]}]}]},{"type":"expand","attrs":{"title":"Do Not Disturb On/Off"},"content":[{"type":"paragraph","content":[{"text":"Do Not Disturb On and Off commands are sent from the PMS to Phonesuite and cause Phonesuite to turn an extension’s Do Not Disturb status on or off, just as if this command were performed from the Browser Console. For these commands, Phonesuite will accept the following formats:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"666e2b4a-0d2b-478e-8c54-3ae6e72e46fd"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Action Phonesuite takes in response","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"12345678901","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"DND1 EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Turn on Do-Not-Disturb for extension EEEE","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"DND0 EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Turn off Do-Not-Disturb for extension EEEE","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"For 3-digit extensions, the extension number the PMS sends can be either right-justified or left-justified within the 4-character EEEE space. Phonesuite will send a in response to a command that does not contain a valid extension number.","type":"text"}]}]}]},{"type":"expand","attrs":{"title":"Group Code"},"content":[{"type":"paragraph","content":[{"text":"The PMS can send Voiceware a group code of human readable letters and/or numbers. For these messages, Phonesuite will format the message text as follows:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"726b2621-c7b6-4988-8d57-54c89ec8e68f"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"1234567890123456789","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"GRP EEE AAAAAAAAAA","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Set group code AAAAAAAAAA for room EEE","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"GRP EEEE AAAAAAAAAA","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Set group code AAAAAAAAAA for room EEEE","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Language"},"content":[{"type":"paragraph","content":[{"text":"A language message can be sent using the ISO 639-1 language codes. For these messages Phonesuite will accept the message format as follows:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"fc5a12a9-8e79-4378-91a2-9564f0023e27"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[208.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[208.0]},"content":[{"type":"paragraph","content":[{"text":"12345678901","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[208.0]},"content":[{"type":"paragraph","content":[{"text":"LNGxxEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":"Set the language for a three-digit guest room. XX is the language code.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[208.0]},"content":[{"type":"paragraph","content":[{"text":"LNGxxEEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":"Set the language for a four-digit guest room. XX is the language code.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"The language codes must be sent in a two letter ISO 639-1 format and always lower case. Three-digit codes or upper-case codes will not set the guest language correctly.","type":"text"}]}]}]},{"type":"expand","attrs":{"title":"Message Waiting Lamp On/Off"},"content":[{"type":"paragraph","content":[{"text":"Message Waiting On and Off commands are sent from the PMS to Phonesuite and cause Phonesuite to turn an extension phone’s Message-Waiting Lamp on or off, just as if this command were performed from the Browser Console. For these commands, Phonesuite will accept the following formats:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"8d3e7ff0-8f53-4527-ab14-b17d540da546"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[390.0]},"content":[{"type":"paragraph","content":[{"text":"Action Phonesuite takes in response","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"12345678901","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[390.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"MW 1 EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[390.0]},"content":[{"type":"paragraph","content":[{"text":"Turn on Message-Waiting lamp for extension EEEE","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"MW 0 EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[390.0]},"content":[{"type":"paragraph","content":[{"text":"Turn off Message-Waiting lamp for extension EEEE","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For 3-digit extensions, the extension number the PMS sends can be either right-justified or left-justified within the 4-character EEEE space. Phonesuite will send a in response to a command that does not contain a valid extension number.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A single space (not more or less) is required between the MW and the 0 or 1.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Changing the Message-Waiting status of an extension does not have any effect on messages in Phonesuite’s voicemail box; it neither adds nor erases messages for the extension.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MW 0 (message-waiting off) will clear the MWI lamp if there are no other unheard messages.","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Move Room Command"},"content":[{"type":"paragraph","content":[{"text":"At times the hotel might want to move a guest from one room to another. It is highly preferred to Phonesuite to use the move command and not a check out and check in. With the move command the guests’ voicemails and wakeup calls are moved with the guest whereas with a check out and back in that data is lost. The move command messages are received by the PMS in the following format:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"15eac0d2-a09a-4b77-a4fc-9967ec9f007f"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"1234567890123456","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"MOV EEE FFF","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Move a guest from room EEE to room FFF.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"MOV EEEE FFFF","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Move a guest from room EEEE to room FFFF.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"The room the guest is currently in is first (EEE) and the room they are moving to is second (FFF). Note also that the from room number must always start at character 6 and the to room starts at character 12.","type":"text"}]}]}]},{"type":"expand","attrs":{"title":"Phone Restrict On/Off"},"content":[{"type":"paragraph","content":[{"text":"The PMS can send Phonesuite a command to restrict or allow dialing from an extension. This command has the same effect as changing an extension’s dialing permissions from the Phonesuite browser console. When a room status code is received Voiceware will match it to a table of restriction levels. This allows complete customization to what permission levels are set without changing the codes a PMS will send. Phonesuite accepts messages in the following format:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"6793d16b-9af3-4c39-a0a8-d22154db83fc"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Action Phonesuite takes in response","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"12345678901","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"RSTn EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Where n is the restriction code passed","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"PMS Database Dump"},"content":[{"type":"paragraph","content":[{"text":"Database Dump messages are used by the PMS to verify that PhoneSuite is active and ready to receive messages, as well as to synchronize the lists of checked-in and checked-out settings and names. For these commands, PhoneSuite will accept any of the following formats:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"ffd18c61-18e4-4115-8e2d-b7534ba3cc9a"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[271.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[459.0]},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[271.0]},"content":[{"type":"paragraph","content":[{"text":"123456789012","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[459.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[271.0]},"content":[{"type":"paragraph","content":[{"text":"AREYUTHERE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[459.0]},"content":[{"type":"paragraph","content":[{"text":"PMS Connection Check","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[271.0]},"content":[{"type":"paragraph","content":[{"text":"GRS","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[459.0]},"content":[{"type":"paragraph","content":[{"text":"Indication that the PMS is going to send a full database dump","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[271.0]},"content":[{"type":"paragraph","content":[{"text":"END","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[459.0]},"content":[{"type":"paragraph","content":[{"text":"Indication that the PMS’ database dump is complete","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"The AREYUTHERE message is simply a request for a response. Phonesuite acknowledges this message with the character, to let the PMS know it is connected and is receiving messages. The GRS and END messages mark the start and end of a total PMS database dump to Phonesuite.","type":"text"}]},{"type":"paragraph","content":[{"text":"Immediately after the GRS message is sent and acknowledged by Phonesuite, the PMS will send a check-in or check-out message for each room; name messages and restriction codes may also be sent. Phonesuite will check its settings to ensure they match what the PMS sends, and it will perform any commands that do not match. That is, if Phonesuite shows extension 132 as being checked in, but the PMS database dump shows it as checked out, Phonesuite will perform the Check-Out command for this extension. When the PMS has completed the database dump, it will mark this fact by sending the END message, which Phonesuite will acknowledge.","type":"text"}]}]},{"type":"expand","attrs":{"title":"Request PMS Database"},"content":[{"type":"paragraph","content":[{"text":"When booting up Phonesuite will send a request to sync with the PMS. This will cause Phonesuite to send the PMS a request in the following format:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"e25559ef-b83b-42f4-ba19-2ae8e176c50e"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"123456","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"RQINZ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Request PMS Database Dump","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"After this message is sent, the PMS, if connected and ready, will follow the PMS Database Dump process described earlier.","type":"text"}]}]}]},{"type":"expand","attrs":{"title":"Room Status"},"content":[{"type":"paragraph","content":[{"text":"Room status messages are sent ","type":"text"},{"text":"from ","type":"text","marks":[{"type":"em"}]},{"text":"Phonesuite ","type":"text"},{"text":"to ","type":"text","marks":[{"type":"em"}]},{"text":"the PMS whenever the room status code is set or changed by a maid in a room or from the console. For these messages, Phonesuite will format the message text as follows:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"b3afb83b-dccd-49f2-bfa5-bdee74249d29"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[153.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[577.0]},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[153.0]},"content":[{"type":"paragraph","content":[{"text":"12345678901","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[577.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[153.0]},"content":[{"type":"paragraph","content":[{"text":"STSn EEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[577.0]},"content":[{"type":"paragraph","content":[{"text":"Indication that the Room Status for extension EEE was set to ","type":"text"},{"text":"n ","type":"text","marks":[{"type":"em"}]},{"text":"(default format)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[153.0]},"content":[{"type":"paragraph","content":[{"text":"STSn EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[577.0]},"content":[{"type":"paragraph","content":[{"text":"Indication that the Room Status for extension EEEE was set to ","type":"text"},{"text":"n ","type":"text","marks":[{"type":"em"}]},{"text":"(default format)","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"Where ","type":"text"},{"text":"n ","type":"text","marks":[{"type":"em"}]},{"text":"is an ASCII number between 0 and 9, inclusive. A single space will appear in the message text between the STS","type":"text"},{"text":"n ","type":"text","marks":[{"type":"em"}]},{"text":"command and the extension number.","type":"text"}]}]}]},{"type":"expand","attrs":{"title":"Send Drop In Voicemail Message"},"content":[{"type":"paragraph","content":[{"text":"Voiceware can have up to 10 prerecorded messages available to drop into a guest’s voicemail box. These messages can be dropped in via a user with the Browser Console or via a PMS message. The drop in message command are received by the PMS using the following format:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"e6371525-a8cb-4c83-9f84-88d2b0996026"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[208.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[208.0]},"content":[{"type":"paragraph","content":[{"text":"12345678901","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[208.0]},"content":[{"type":"paragraph","content":[{"text":"MSGn EEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":"Drop message n (where n is a number between 0 and 9) for room EEE.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[208.0]},"content":[{"type":"paragraph","content":[{"text":"MSGn EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":"Drop message n (where n is a number between 0 and 9) for room EEEE.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"Sending MSG0 will turn off the guest’s message waiting lamp, sending 1-9 will drop in a message to the guest’s voicemail box thus turning on the message lamp. Voiceware will send an ACK even if Voiceware does not have a drop in message that corresponds with the number sent from the PMS. Also note once sent these messages cannot be undone.","type":"text"}]}]}]},{"type":"expand","attrs":{"title":"Set Room Name(s)"},"content":[{"type":"paragraph","content":[{"text":"A single guest name can be assigned to each guest room. For this command, Phonesuite will accept the following format:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"da9ba1bf-7b73-4efd-8d22-d60b8e157636"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Action Phonesuite takes in response","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"123456789012345678901234567890","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"NAMn Name EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Sets the primary name","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"where n is a number between 1 and 4 and must immediately follow the NAM command (no spaces).","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For 3-digit extensions, the extension number the PMS sends can be either right-justified or left-justified within the 4-character EEEE space. Phonesuite will send a in response to a command that does not contain a valid extension number.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The name can be any length up to a maximum of 20 characters, in upper, lower, or mixed case; this name can be in the format LAST,FIRST (comma delimiter only), or LAST, FIRST (both comma and space delimiter), or FIRST LAST (space only delimiter signifies first name, then last name).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A space is necessary between the NAMn command and the name, and at least one space must be included between the name and the extension number.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Phonesuite will display the stored name on the Browser Console and on SIP phones when a call from the extension is answered.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The number after NAM can be between 1 and 4 but will always update the primary guest’s name.","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Set/Clear DID Number"},"content":[{"type":"paragraph","content":[{"text":"The PMS can send Phonesuite a command to set or clear a DID assignment for any room. For these commands, Phonesuite will accept the following formats:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"f0a0211d-fc29-441b-b7a7-c7262f109344"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Action Phonesuite takes in response","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"123456789012345","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"DID1 EEEE DDDD","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Assign extension EEEE the DID number DDDD","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"DID0 EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Clear DID assignment for extension EEEE","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"The extension number EEEE must match a valid room extension number.","type":"text"}]}]}]},{"type":"expand","attrs":{"title":"VIP Status"},"content":[{"type":"paragraph","content":[{"text":"Voiceware can mark a guest as having a VIP status. This flag is only set via a PMS message. This message uses the following format:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"0673eb53-cf8e-40d1-8257-d2c0c345a840"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[204.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[526.0]},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[204.0]},"content":[{"type":"paragraph","content":[{"text":"12345678901","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[526.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[204.0]},"content":[{"type":"paragraph","content":[{"text":"VIPn EEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[526.0]},"content":[{"type":"paragraph","content":[{"text":"Sets or clears a VIP flag using n=1 to set and n=0 to clear for room EEE.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[204.0]},"content":[{"type":"paragraph","content":[{"text":"VIPn EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[526.0]},"content":[{"type":"paragraph","content":[{"text":"Sets or clears a VIP flag using n=1 to set and n=0 to clear for room EEEE.","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Voicemail Status"},"content":[{"type":"paragraph","content":[{"text":"A voice mail status message is sent ","type":"text"},{"text":"from ","type":"text","marks":[{"type":"em"}]},{"text":"Phonesuite ","type":"text"},{"text":"to ","type":"text","marks":[{"type":"em"}]},{"text":"the PMS. Phonesuite will send MSG2 with a flag of 1 on the first occurrence of a voice mail being left for an extension and MSG2 with a flag of 0 when all voice mail messages have been listened to or deleted. For these messages, Phonesuite will format the message text as follows:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"37d5a5c1-0d19-4b46-a942-f6871c3148ff"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[578.0]},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"1234567890123","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[578.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"MSG2 EEE 0","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[578.0]},"content":[{"type":"paragraph","content":[{"text":"All voice mails for extension EEE were listened to or deleted","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"MSG2 EEEE 0","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[578.0]},"content":[{"type":"paragraph","content":[{"text":"All voice mails for extension EEEE were listened to or deleted","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"MSG2 EEE 1","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[578.0]},"content":[{"type":"paragraph","content":[{"text":"A voice mail message was recorded for extension EEE and there was no previous message that had not been listened to","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"MSG2 EEEE 1","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[578.0]},"content":[{"type":"paragraph","content":[{"text":"A voice mail message was recorded for extension EEE and there was no previous message that had not been listened to","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Voicemail Message Count"},"content":[{"type":"paragraph","content":[{"text":"Voiceware can send ","type":"text"},{"text":"to","type":"text","marks":[{"type":"underline"}]},{"text":" the PMS a voicemail message count for a guest room. This message uses the following format:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"fe3538c5-3c61-43e7-bee6-7905ae6d6a6b"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"12345678901","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"MCTn EEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Number of messages n for guest room EEE.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"MCTn EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Number of messages n for guest room EEEE.","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Wakeup Call Set/Change/Clear"},"content":[{"type":"paragraph","content":[{"text":"The PMS can send Phonesuite a command to set, change, or clear a wakeup call for a given extension. This command has the same effect as setting, changing, or clearing a wakeup call from the Phonesuite Browser Console, with only the time (no date) specified. The result is that the wakeup call will ring the extension whenever the specified time is next reached by Phonesuite’s system clock. For these commands, Phonesuite will accept any of the following formats:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"a88218cf-dae9-4cb7-957d-fca80e9fc242"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[173.0]},"content":[{"type":"paragraph","content":[{"text":"Message Text","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[557.0]},"content":[{"type":"paragraph","content":[{"text":"Action Phonesuite takes in response","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[173.0]},"content":[{"type":"paragraph","content":[{"text":"1234567890123","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[557.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[173.0]},"content":[{"type":"paragraph","content":[{"text":"WKPhhmm EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[557.0]},"content":[{"type":"paragraph","content":[{"text":"Set a Wakeup call for extension EEEE at hhmm (24-hour time format)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[173.0]},"content":[{"type":"paragraph","content":[{"text":"WKP9999 EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[557.0]},"content":[{"type":"paragraph","content":[{"text":"Clear any Wakeup call for extension EEEE","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[173.0]},"content":[{"type":"paragraph","content":[{"text":"WKP EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[557.0]},"content":[{"type":"paragraph","content":[{"text":"Clear any Wakeup call for extension EEEE","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[173.0]},"content":[{"type":"paragraph","content":[{"text":"WKP EEEE","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[557.0]},"content":[{"type":"paragraph","content":[{"text":"Clear any Wakeup call for extension EEEE","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Where hhmm is the wakeup time, in 24-hour format (hh = hours and mm = minutes) with no spaces or additional characters and must immediately follow the WKP command (no spaces allowed). The HH or MM must be left-padded with a 0 if the value is less than 10 (e.g., 5 minutes past 7:00 would be specified as 0705, and 2:30 p.m. would be specified as 1430). If the wakeup time is 9999, all spaces, or is blank (with at least one space between the WKP command and the extension number), any wakeup call for that extension will be cleared. A space is necessary between the time and the extension number.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Special Flags","type":"text"}]},{"type":"paragraph","content":[{"text":"Each installation and individual PMS interface can set a series of flags that will alter the way that any PMS interface works. These flags are set in the additional parameters box within Voiceware. These flags are as outlined below.","type":"text"}]},{"type":"expand","attrs":{"title":"Special Flags"},"content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"[pbx-protocol]","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"checkinmessage=n","type":"text","marks":[{"type":"strong"}]},{"text":" (i.e. checkinmessage=2). Automatically places drop in message two into a guests mail box upon check in. This is a PBX mask.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"[pbx-masks]","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"swapnames=true/false","type":"text","marks":[{"type":"strong"}]},{"text":" Default is true. Set to false if the PMS is sending ","type":"text"},{"text":"Firstname,Lastname","type":"text","marks":[{"type":"code"}]},{"text":" in check in or name change messages.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"nameindex0=0/1/2/3","type":"text","marks":[{"type":"strong"}]},{"text":" Most PMS systems send 0 on any name commands (i.e. NAM0) to change the first guest in the room. However some PMS systems will send NAM2 when they want to change the first guest name. In this case set the index to 2 and Psip will change the 2 to a 0.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"[ca-method]","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"email=[address]","type":"text","marks":[{"type":"strong"}]},{"text":" (i.e. email=Admin@HolidayInnBlackCannyon.com). This email address is used to send billable calls should the call accounting interface become unavailable so the call can be posted to the guest record manually.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"[ca-protocol]","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"strip=1/0","type":"text","marks":[{"type":"strong"}]},{"text":" [True/False] (i.e. strip=1, default is 0). This will strip all leading 0 and 1 off the beginning of the number dialed.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"format=1/0","type":"text","marks":[{"type":"strong"}]},{"text":" [True/False] (i.e. format=1, default is 0). This will format the dialed number into NPA-NXX-XXXX, works best with strip=True (above).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"incoming=1/0","type":"text","marks":[{"type":"strong"}]},{"text":" [True/False] (i.e. incoming=1, default 0). If set to true Voiceware will pass incoming calls to the PMS.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"admin=1/0","type":"text","marks":[{"type":"strong"}]},{"text":" [True/False] (i.e. admin=1, default 0). If set to true then Psip-PMS will send admin calls to the PMS. Default is false.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"zero=1/0","type":"text","marks":[{"type":"strong"}]},{"text":" [True/False] (i.e. zero=1, default is 0). Setting this to true will send all zero cost guest calls to the PMS. For admin calls see admin= above.","type":"text"}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"To use enter the message flag along with the section header in brackets, a completed entry might look like:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1038,"id":"81c7ba7b-d9b7-4fe8-bf9b-80533fd430c2","collection":"contentId-21692417","type":"file","height":347}}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Manual","type":"text"}]},{"type":"paragraph","content":[{"text":"Below is the manual that can be sent to PMS companies who are setting up new interfaces to Phonesuite, it contains all the information listed above.","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"cadd5c77-1dcb-4b6d-b7e4-5062e05b67d5","collection":"contentId-21692417","type":"file"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"XMLRPC","type":"text"}]},{"type":"paragraph","content":[{"text":"Psip communicates with Voiceware using a protocol called XMLRPC. More about this interface can be found using the below URL on any Voiceware system, swapping out the with the IP of the system. All XMLRPC interfaces for all versions of Voiceware are the same. ","type":"text"}]},{"type":"paragraph","content":[{"text":"http:///phonesuite/xml-rpc.php?action=PMS","type":"text","marks":[{"type":"link","attrs":{"href":"http://192.168.2.142/phonesuite/xml-rpc.php?action=PMS"}}]}]},{"type":"paragraph","content":[{"text":"Live logs of all XMLRPC calls can also be viewed from the command line interface with the below command.","type":"text"}]},{"type":"paragraph","content":[{"text":"ngrep -q -d any -W byline '' tcp port 8080","type":"text","marks":[{"type":"code"}]}]}],"version":1}