mailbox.alias.find

Mailbox aliases are used to group the mailboxes of multiple things thus simplifying the mailbox.send command. This command views basic information about an alias and its things.

TR50 Request

// By id
{
  "cmd": {
    "command": "mailbox.alias.find",
    "params": {
      "id": "56ddec31681fdc646f116c36"
    }
  }
}
 
// By key
{
  "cmd": {
    "command": "mailbox.alias.find",
    "params": {
      "key": "@MYALIAS"
    }
  }
}

Request Parameters

Name Type Required Description One of the two identification fields is required. id String Object id of the alias. key String Object key of the alias.

TR50 Response

{
  "auth": null,
  "data": {
    "success": true,
    "params": {
      "id": "56ddec31681fdc646f116c36",
      "name": "Alias test",
      "key": "@MYALIAS",
      "policy": "random",
      "things": [
        {
          "id": "54934bae74e00c110f000043"
        },
        {
          "id": "55c0d177681fdc3ccb0e6ccc"
        }
      ],
      "createdBy": "user@example.com",
      "createdOn": "2016-03-07T21:01:37.894Z",
      "updatedBy": "user@example.com",
      "updatedOn": "2016-03-07T21:01:37.894Z"
    }
  }
}

Response Parameters

Name	Type	Description
id	String	ID of the alias.
name	String	Name of the alias.
key	String	Alias key starting with the "@" character.
policy	String	Not used by the Portal. Currently hard-coded to "random".
things	Array	Array of thing IDs.
createdBy	String	User who created the alias.
createdOn	String	Date the alias was created.
updatedBy	String	User who last updated the alias.
updatedOn	String	Date the alias was updated.

Result Array Object

Name	Type	Description
id	String	Thing ID.