System

This endpoint group provides mechanisms for the client to submit responses to commands or events initiated by the server.

Endpoints

POST /api/rpc (Method: SystemRpc.submitCommandResponse)

• Description: Receives a command response from the client.

• Request Body:

  {
    "method": "SystemRpc.submitCommandResponse",
    "params": {
      "responseEventId": "string",
      "response": {}
    }
  }

• Parameters:

  Name	Type	Required	Description
  responseEventId	String	Yes	The ID of the event for which this response is intended.
  response	Any	Yes	The actual response data from the client.

• Response:

  {
    "success": true,
    "data": {
      "success": true
    }
  }

• Example (cURL):

  curl -X POST https://api.example.com/api/rpc \
    -H "Content-Type: application/json" \
    -H "X-API-Key: YOUR_API_KEY" \
    -d '{
      "method": "SystemRpc.submitCommandResponse",
      "params": {
        "responseEventId": "some-unique-event-id-123",
        "response": {
          "status": "success",
          "data": "user-input-value"
        }
      }
    }'