Mailbox Record

This interface uses posts most of the mailbox record to the server as a JSON object. This remote host may be located on the local network or even on a remote server on the internet. The host may be written in any language suitable for the remote party, this includes PHP, C#, and C/C++.

Requirements

PBX Link License.
DuVoice 6.03 or above.

Revision History

Version	Released	Changes
201	2021/03/25	Added custom information field for mailbox record.
200	2019/10/10	Added number of attempts, post_date, and post_time for better tracking and reporting.
200	2019/08/20	Added arrival, departure, check in, and check out dates.
200	2018/01/30	Initial release

Configuration

Using System Configuration, configure the PBXLink for your profile as HTTP Post.

Setting	Default	Description
URL	Blank	Enter full URL to post items to. Example: http://127.0.0.1:8080/pbx
Username	Blank	If using authentication enter username.
Password	Blank	If using authentication enter password.
Format	POST Form Data	Type of data to post to server.
Resource	None	Can be used to add a mailbox or extension automatically as part of the URL. Example: http://127.0.0.1:8080/pbx/7101
Slash	Unchecked	Add additional slash at end of URL.
Retries	3	Number of retries before giving up.
Interval (seconds)	60	Number of seconds to wait between retries.
Timeout (seconds)	10	Number of seconds to wait for response from server.

Response Errors

HTTP Code	Description
200	Success.
401	Not authorized. Postings will not be retried.
404	Failure. Posting will not be retried.
Other	Will attempt retry.

Syntax

Field Descriptions

Name	Type	Description
arrivaldate	timestamp	The arrival date for this room.
attempts	integer	Zero based number of attempts.
callScreening	bool	Is call screening enabled. Also known as DND
cos	string	Class of service name.
checkindate	timestamp	Last time room was checked in.
checkoutdate	timestamp	Last time room was checked out.
created	timestamp	When the mailbox was created.
custominfo	object	Container of custom data added via REST API or DuVoice.
departuredate	timestamp	The departure date for this room.
description	string	Description field.
directory	bool	Is the mailbox listed in the telephone directory.
dnd	bool	Is call screening enabled. Also known as DND
extensions	array	Array of extensions associated with mailbox.
firstName	string	First name of mailbox.
greeting	Number	Greeting number of mailbox.
guestinfo	object	Container of room data added via REST API or DuVoice. Deleted at check in and out. Follows guest on room move.
id	string	Mailbox number. Mailbox numbers may be prefixed with zeros.
language	int	Language set for room. 0 = System Default, otherwise language number.
lastLogin	timestamp	When the mailbox user last logged in.
lastName	string	Last name of mailbox.
maidstatus	int	Maid status of the room.
modified	date	When was the mailbox last modified.
mwi	bool	Will only be sent on MWI change.
occupied	bool	True if occupied, otherwise false.
pmsGuest	string	Guest ID used for some PMS systems.
pmsGroups	array	List of Group mailboxes room is a member of.
post_date	string	Date we posted this record.
post_time	string	Time we posted this record.
restriction	int	Room restriction setting.
roominfo	object	Container of room data added via REST API or DuVoice. Deleted at check in and out.
tenant	string	Tenant ID for this mailbox.
textcount	int	Number of text messages for this room.
title	string	User title of the mailbox. Typically Mr or Mrs.
tutorial	bool	Is mailbox tutorial enabled.
type	int	Mailbox type.
vip	bool	Is the guest VIP.

Example

POST /httppost HTTP/1.1
Date: 2021-03-25T18:31:53Z
User-Agent: DuVoice/7.1.21 HTTPPOST/201
Content-Length: 1022
Content-Type: application/json
Connection: Close
Host: 127.0.0.1:8080
 
{
  "arrivaldate" : "",
  "attempt" : 0,
  "callScreening" : false,
  "checkedindate" : "20210325101522623",
  "checkedoutdate" : "",
  "cos" : "guest",
  "created" : "20190604215303759",
  "custominfo" : {
    "bed_type" : "King",
    "dbid" : "122349d9dlda93"
  },
  "departuredate" : "",
  "description" : "Polycom vx500",
  "directory" : true,
  "dnd" : true,
  "extensions" : [
    "7101"
  ],
  "firstName" : "Brock",
  "greeting" : 0,
  "guestinfo" : {
    "ccard" : "123456781234"
  },
  "id" : "7101",
  "language" : 0,
  "lastLogin" : "",
  "lastName" : "Sampon",
  "maidStatus" : 0,
  "modified" : "20210325113152783",
  "occupied" : true,
  "pmsGroups" : [
    "0120210325",
    "8000"
  ],
  "pmsGuest" : "",
  "post_date" : "20210325",
  "post_time" : "11:31:53",
  "restriction" : "",
  "roomid" : "1-7101",
  "roominfo" : {
    "maid_note" : "Double snacks"
  },
  "tenant" : "8b9a6860-4a38-11e7-b52d-902b34db254e",
  "textCount" : 0,
  "title" : "Mr.",
  "tutorial" : false,
  "type" : 5,
  "vip" : true
}

Table of Contents