1N1nce
IoT Integrator

Create Action Request On Specific CoAP Device.

Initiate CoAP action on specific device.

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

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

Data that should be sent to a device

payloadType'STRING' | 'BASE64'

Type of the payload

portinteger required

Communication port number of a device

pathstring required

Absolute path to the resource

requestType'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' required

CoAP request type that should be sent

requestMode'SEND_NOW' | 'SEND_WHEN_ACTIVE'

Action request execution mode

sendAttemptsnumber

The maximum number of attempts to send data to a device

Example request

{
  "payload": "enable_sensor",
  "port": 3000,
  "path": "example?param1=query_param_example"
}

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.