ANangelcam
rts_messages

Update message

Update messages

put/rts/messages/{message_id}/

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_manage
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

message_idinteger required

Message ID

Request body

is_readboolean

Was message read by user?

Response

OK

idnumber required

Message ID

created_atstring required

Time when message was created, format %Y-%m-%dT%H:%M:%SZ

titlestring required

Message title

type'my_incident' | 'shared_incident' | 'arming' | 'trigger_action' | 'open_incident_verification' | 'verify_incident' | 'close_incident' | 'arrow_status_online' | 'arrow_status_offline' | 'camera_status_online' | 'camera_status_offline' required

Message type. Can be used to decide for instance priority of the message.

short_messagestring required

Short version of message. Use short version for example in notification list

long_messagestring required

More detailed version of message. Use long version in message detail or when sending via e-mail.

is_readboolean required

Whether message was read by user.

read_atstring

Time when message was read, format %Y-%m-%dT%H:%M:%SZ

imagestring

URL of image that is related to the message.

action_urlstring

URL to a particular screen in webapp or mobile app that is related to this message. Required when show_detail == false

action_labelstring

Label for button that should redirect to action_url

show_detailboolean required

Whether to show detail of message or redirect user directly to action_url

incident_sharing_urlstring

URL that can be used for incident verification by third parties. The URL leads to a web page where all cameras from the affected location can be viewed (live streams + the last two hours of recording). The URL is valid for one hour after the corresponding incident is created. This field will be null if the message type isn't my_incident or if the URL is no longer valid.

Example response

{
  "id": 1,
  "created_at": "2019-08-09T13:23:23.000Z",
  "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,
  "read_at": "2019-08-09T13:23:30.000Z",
  "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,
  "incident_sharing_url": null
}

Changes

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