mailbox.forward

The mailbox.forward command identifies message with a status of "new" and "in-flight" for a specific thing, and then forwards the messages to a different thing.

TR50 Request


                        {
  "cmd": {
    "command": "mailbox.forward",
    "params": {
      "thingKey": "thing_key_1",
      "targetThingKey": "thing_key_2"
    }
  }
}
      

Request Parameters

Name

Type

Required

Description

thingKey

String

Yes

The key of the thing from which messages will be forwarded.

targetThingKey

String

Yes

The key of the thing that the messages will be forwarded to.

TR50 Response

If the command is sent successfully a success message and the number of messages forwarded is returned. Otherwise, an error and error message will be returned.


                        {
  "cmd": {
    "success": true,
    "params": {
      "count": 9
    }
  }
}
      

Response Parameters

Name

Type

Description

count

Integer

The number of messages forwarded.