mailbox.find

The mailbox.find command finds a mailbox item.

TR50 Request


                        {
  "cmd": {
    "command": "mailbox.find",
    "params": {
      "id": "53cfbcc7f837ba50271043c6"
    }
  }
}
      

Request Parameters

Name

Type

Required

Description

id

String

Yes

The unique identifier of the mailbox item.

TR50 Response

If the command is sent successfully a success message and the result is returned. Otherwise, an error and error message will be returned.


                        {
  "cmd": {
    "success": true,
    "params": {
      "id": "5355308d3100465335003f5b",
        "thingKey": "alam.abcde",
        "thingId": "533f0ff23100461e14002575",
        "from": "53552d6031004653350000c6",
        "command": "method.exec",
        "status": "in-flight",
        "history": [
          {
            "status": "new",
            "ts": "2014-07-23T09:46:47.826-04:00"
          },
          {
            "status": "in-flight",
            "ts": "2014-07-23T09:46:47.893-04:00"
          },
          {
            "status": "completed-error",
            "ts": "2014-07-23T09:46:47.896-04:00"
          }
        ],
        "updated": "2014-07-23T09:46:47.896-04:00"    
    }
  }
}
      

Response Parameters

Name

Type

Description

id

String

The unique identifier of the mailbox item.

thingKey

String

The key of the thing associated with the message.

thingId

String

The unique identifier of the thing associated with the message

from

String

The origin of the mailbox message.

command

String

The name of the command that was executed.

status

String

The status of the mailbox message.

history

Array

The array of the status history.

history.status

String

The historical status.

history.ts

String

The timestamp the record was in this status.

history.message

String

The message.

params

Object

An object containing parameters to be used by the command.

updated

String

The timestamp the message was last updated.

duration

Integer

For completed items, the number of (whole) seconds it took for the mailbox item to complete.