messages ID

documentation not finished

Description get or delete message by ID

http://localhost:5000/freedata/messages/{message_id}

Parameters

message_id

GET, DELETE or PATCH

Example

curl --request GET --url http://localhost:5000/freedata/messages/DXCALL-0_MYCALL-5_2024-04-04T17:22:14.002502 --header 'Content-Type: application/json'

Results

{
  "id": "DXCALL-6_MYCALL-0_2024-04-12T20:39:05.302479",
  "timestamp": "2024-04-12T20:39:05.302479",
  "attempt": 0,
  "origin": "DXCALL-6",
  "via": null,
  "destination": "MYCALL-0",
  "direction": "receive",
  "body": "Hello !",
  "attachments": [],
  "status": "received",
  "priority": 10,
  "is_read": false,
  "statistics": {
    "total_bytes": 120,
    "duration": 29.76698660850525,
    "bytes_per_minute": 241,
    "time_histogram": {
      "0": "2024-04-12T20:39:23.423169",
      "1": "2024-04-12T20:39:30.504638",
      "2": "2024-04-12T20:39:37.745075"
    },
    "snr_histogram": {
      "0": -6,
      "1": -6,
      "2": -6
    },
    "bpm_histogram": {
      "0": 198,
      "1": 265,
      "2": 252
    }
  }
}

curl --request DELETE --url http://localhost:5000/freedata/messages/DXCALL-0_MYCALL-5_2024-04-04T17:22:14.002502 --header 'Content-Type: application/json'

Results

{
  "message": "DXCALL-0_MYCALL-5_2024-04-04T17:22:14.002502 deleted",
  "status": "success"
}
{
  "message": "Message not found",
  "status": "failure"
}

Example

curl --request PATCH --url http://localhost:5000/freedata/messages/DXCALL-0_MYCALL-5_2024-04-04T17:22:14.002502 --header 'Content-Type: application/json'

Results

{
  "is_read": true
}

Errors

This API uses the following error codes:

  • 404 Not Found: The requested resource was not found.
  • 503 Modem not running: Modem not running.