Module: submitForwardMessages

submitForwardMessages

require("submitForwardMessages")(mobileId, message, userMessageId)

services/submitForwardMessages.js, line 54

Submits a command/message to a specified remote modem.

Emits events:

  • NewForwardMessage
  • NewMobile
  • ApiError
  • ApiOutage
  • ApiRecovery
Name Type Description
mobileId string

The destination of the message
message Object

A wrapper for the command/message

Name Type Description
payloadJson Object optional
payloadRaw Array.<number> optional

An array of decimal bytes [0..255]
modemCommand ModemCommand optional

A supported modem command shorthand
userMessageId number optional

an optional user message ID number

submitForwardMessages module

Type Definitions

ModemCommandObject

A command structure shorthand for standard core modem operations

Properties:
Name Type Argument Description
command string

The shorthand command name
  'ping' (no params)
  'getLocation' (no params)
  'setWakeupPeriod' (string)
  'getConfiguration' (no params)
  'reset' (optional string)
  'setTxMute' (boolean)
  'getBroadcastIds' (no params)
params * <optional>

Parameter(s) specific to the command

PayloadJsonObject

A JSON message structure

Properties:
Name Type Argument Description
codecServiceId number

A service definition number [16..255]
codecMessageId number

A message definition number [0..255]
name string <optional>

The message name
fields Array.<Object>

A list of Field objects (https://github.com/Inmarsat/isatdatapro-api)