rts_messages

Retrieve messages

Retrieves list of user messages

get/rts/messages/

Request

  • Base URL
    https://api.angelcam.com/v1
  • Auth
    • OAuth 2
      Authorization codehttps://my.angelcam.com/oauth/authorize/, token URL https://my.angelcam.com/oauth/token/
      PasswordToken URL https://api.angelcam.com/oauth/token/
      Scopesmessages_access
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

limitinteger

Limit result set. Example: 1.

nextstring uri

Cursor for the next page, taken from next field of a previous response.

Response

OK

countinteger required

Count of all messages

nextstring uri nullable required

Next page from pagination

previousstring uri nullable required

Previous page from pagination

Example response

{
  "count": 10,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "created_at": "2019-08-09T13:23:23Z",
      "title": "Sensor My Sensor detected motion",
      "type": "my_incident",
      "short_message": "Your sensor with name My Sensor detected motion.",
      "long_message": "Your sensor with name My Sensor detected motion. Find out more at <url>.",
      "is_read": false,
      "image": "https://s3.us-west-2.amazonaws.com/rec-prod.us-west-2.angelcam.com/c/944c8ee2-0230-4dbf-b03d-de09dc4a79da.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJ6CMNV7APGJB5JYQ%2F20180416%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20180416T093432Z&X-Amz-Expires=86400&X-Amz-Signature=40b3701f85114ed22f76a97e6b0c099b1dc7301645bd2db8380c5fa824c59455&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D%22Frontdoor%20loitering.jpg%22",
      "action_url": "https://my.angelcam.com/camera/1/",
      "action_label": "Show camera",
      "show_detail": false
    }
  ]
}

Changes

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