Soracom Beam

TCP → TCP/TCPS Entry Point

This entry point accepts TCP traffic from an Air for Cellular device and forwards the individual packet to the forwarding destination via TCP or TCPS.

Configuration

Entry Point

Your device should be configured to send TCP traffic to: beam.soracom.io:8023.

Parameters

• Configuration name (string, required) - A string to identify this configuration.
• Destination - The forwarding destination.
  • Protocol (TCP or TCPS, required) - The protocol to use for forwarding TCP traffic.
  • Host name (string, required) - The FQDN of the forwarding destination.
  • Port number (number, required) - The port number of the forwarding destination.
• Header manipulations - Operations to perform on the TCP packet.
  • IMSI header - Adds imsi={IMSI} to the first line of the packet as a string.
  • SIM ID header - Adds simId={SIM_ID} to the first line of the packet as a string.
  • MSISDN header - Adds msisdn={MSISDN} to the first line of the packet as a string.
  • IMEI header - Adds imei={IMEI} to the first line of the packet as a string.
  • Signature header - Adds imei={IMEI} imsi={IMSI} timestamp={timestamp};signature={signature} version=20151001 to the first line of the packet as a string. This option requires IMSI header or IMEI header to be enabled in order to generate the signature.
  • Pre-Shared Key - The key to use when generating the Signature header.

Refer to the Header Manipulations documentation for additional details.

Advanced Configuration

The TCP → TCP/TCPS entry point can also be configured through the Soracom API or CLI by using the SoracomBeam namespace.

Configuration should be performed using tcp://beam.soracom.io:8023 as the configuration key value.

Parameters

• key (string, required) - tcp://beam.soracom.io:8023
• value (object, required) - The configuration parameters.
  • name (string, optional) - Name to identify this configuration.
  • destination (string, required) - URL of the forwarding destination.
  • enabled (boolean, required) - Enables or disables the configuration.
  • addSubscriberHeader - (boolean, optional) - Enables or disables adding the subscriber IMSI in the forwarded request.
  • addSimIdHeader - (boolean, optional) - Enables or disables adding the SIM ID in the forwarded request.
  • addMsisdnHeader - (boolean, optional) - Enables or disables adding the SIM MSISDN in the forwarded request.
  • addSignature (boolean, required) - Enables or disables adding a signature header for subscriber verification
  • psk.$credentialsId (string, optional) - The ID assigned to the pre-shared key credential set. Used for signing when addSignature is set as true. This ID is set when the credential is registered in the Credentials Store.

Sample

[
  {
    "key":"tcp://beam.soracom.io:8023",
    "value": {
      "name": "beamtest",
      "destination": "tcps://beamtest.soracom.io:1234",
      "enabled": true,
      "addSubscriberHeader": true,
      "addSimIdHeader": true,
      "addMsisdnHeader": true,      
      "addSignature": true,
      "psk": {
        "$credentialsId": "CredentialsID"
      }
    }
  }
]