IoT Integrator

Create Action Request On Specific UDP Device.

Initiate UDP action on specific device.

post/v1/integrate/devices/{deviceId}/actions/UDP

Request

  • Base URL
    https://api.1nce.com/management-api
  • Auth
    HTTP bearer

Path parameters

deviceIdstring required
Example:<device_id>

The unique device ID which identifies each 1NCE SIM. Can be obtained from the Get All Devices API query. For 1NCE SIMS the device ID is equal to its iccid.

Request body

payloadstring required

Data that should be sent to a device

payloadType'STRING' | 'BASE64' required

Type of the payload

portinteger required

Communication port number of a device

requestMode'SEND_NOW' | 'SEND_WHEN_ACTIVE'

Action request execution mode

Example request

{
  "payload": "enable_sensor",
  "port": 3000
}

Response

Message describing the result of operation

idstring required

Id of the created action request

messagestring required

Message describing the result of operation.

Example response

{
  "id": "trxHeBL0d234fsfds",
  "message": "Action write for resource /3/45/22 successfuly scheduled for device _vGxHeBL0dE9LG9EB2GHj."
}

Changes

No recorded changes to this operation across all 1 revision of this API.