Send announcement to device from Link

Send announcement to device from Link or other server. Announcement will be displayed in the messaging app. When user open the message - device must send confirmation to Link.

Please check Link API reference for expected responses https://app.swaggerhub.com/apis-docs/basip/link-server-api/1.0.0#/Secured/post_devices_announce_response

application/json

Request Body required

• author string

  Possible values: <= 191 characters

  Author of the message on the server

• body string

  Body of the mesage

• type string

  Possible values: [info]

  Type of the message, currently only info available

• subject string

  Possible values: <= 191 characters

  Subject of the message

• announce_token uuid

  Possible values: <= 50 characters

  Message token, used as a unique identifier for the message on the server

Responses

• 200
• 400
• 401

---

OK

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• error object

  Describes the base error user might get

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  Describes the parameter that did not pass a validation

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be a string"
    }
  }
}

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Describes the base error user might get

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  Describes the parameter that did not pass a validation

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be a string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Log In"
  }
}

Loading...