GET /mailbox
Retrieve information for one or more mailboxes.
Not all fields may be contained in a response. For example the password is never returned for security reasons.
| Authentication | Required |
|---|---|
| URI Path | /rest/mailbox/<id> |
| Version | 6.1.0 |
Method Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| id | no | string | Mailbox number. |
Query Parameters
Optional parameters when not specifying a specific mailbox.
| Parameter | Type | Description |
|---|---|---|
| filter | string | Filter the list of mailboxes returned. in - Only checked in rooms. out - Only checked out rooms. vip - Only rooms which are VIP. |
| tenant | string | Only return mailboxes in a specific tenant. If the account of the user is locked to a tenant they will only ever see those in that tenant. |
| type | int or string | This returns a simple list of all mailboxes types requested. Specify the type of mailbox to return, a csv or all Examples: type=5 Return only rooms. type=0,5 Return all rooms and users. type=all Return all mailboxes. |
Resource Errors
| HTTP Code | Description |
|---|---|
| 200 | Success. |
| 400 | Type or filter provided is invalid. |
| 401 | Not authorized. |
| 404 | Mailbox not found |
| 405 | Method specified is not supported. |
| 500 | Error updating or writing to database. |
Response
Not all mailboxes return the same data based on their type.
(R) = read-only field which cannot be updated or set.
All
| Name | Type | Description |
|---|---|---|
| cosname | string | Class of service name. |
| created | timestamp | When the mailbox was created. (R) |
| description | string | Description field. |
| directory | bool | Is the mailbox listed in the telephone directory. |
| firstName | string | First name of mailbox. |
| id | string | Mailbox number. Mailbox numbers may be prefixed with zeros. (R) |
| language | int | Language set for room. 0 = System Default, otherwise language number. |
| modified | date | When was the mailbox last modified. (R) |
| tenant | string | Tenant ID for this mailbox. |
| type | int | Mailbox type. (R) |
Distribution
| Name | Type | Description |
|---|---|---|
| members | array | Array of current members. |
members
| Name | type | Description |
|---|---|---|
| id | String | Mailbox number. |
Group
| Name | Type | Description |
|---|---|---|
| assignHow | int | How are members assigned. |
| lastAssigned | string | Date and time group was last assigned by the PMS. (R) |
| members | array | Array of current members. |
members
| Name | type | Description |
|---|---|---|
| id | String | Mailbox number. |
Room
| Name | Type | Description |
|---|---|---|
| arrivaldate | string | Arrival date. Example: YYYYMMDD |
| checkedindate | string | Date the room was checked in. Example: YYYYmmddHHMMSSsss |
| checkedoutdate | string | Date the room was checked out. Example: YYYYmmddHHMMSSsss |
| dnd | bool | Do not disturb. |
| guestinfo | array | Custom values about a checked in guest which may have been added via InnDesk or other API's. (R) |
| lastLogin | string | Last time the user logged into the mailbox. (R) |
| lastName | string | Last name of mailbox. |
| maidstatus | int | Maid status of the room. |
| occupied | bool | True if occupied, otherwise false. |
| pmsGuest | string | Guest ID used for some PMS systems. (R) |
| restriction | int | Room restriction setting. |
| roomid | string | A user defined room number. (reserved for future use) |
| roominfo | array | Custom values about a occupied room which may have been added via InnDesk or other API's. (R) |
| 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. |
| vip | bool | Is the guest VIP. |
User
| callScreening | bool | Call screening. |
| dnd | bool | Do not disturb. |
| lastLogin | string | Last time the user logged into the mailbox. |
| lastName | string | Last name of mailbox. |
| title | string | User title of the mailbox. Typically Mr or Mrs. |
| tutorial | bool | Is mailbox tutorial enabled. |
Example
Single mailbox
Request
GET /rest/mailbox/7101
Response
{ "arrivaldate" : "", "callScreening" : false, "checkedindate" : "", "checkedoutdate" : "20190903171240596", "cosname" : "guest", "created" : "20190604215303759", "custominfo" : [ ], "departuredate" : "", "description" : "", "directory" : false, "dnd" : false, "firstName" : "Room 7101", "greeting" : 0, "id" : "7101", "language" : 0, "lastLogin" : "", "lastName" : "", "maidStatus" : 0, "modified" : "20190903171240681", "occupied" : false, "pmsGuest" : "", "restriction" : "", "roomid" : "7101", "tenant" : "8b9a6860-4a38-11e7-b52d-902b34db254e", "textCount" : 0, "title" : "", "tutorial" : false, "type" : 5, "vip" : false }