Search Push Content

Read what the banners of pushed notifications may show, with a content key. A wrong key, or a registration that is unknown, disabled or has no key, is a 404. Otherwise each requested notification is either in ``items`` or left out.

Authorization

BearerAuth

AuthorizationBearer <token>

Botyard API key — see /docs/authentication.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

What a notification service extension asks for (no session required).

registration_id*Registration Id

The registration the push was sent to (rid).

content_key*Content Key

The registration's current content key.

notification_ids*array<>

Notifications to read (nid of each push), each at most once. Per-item: an id that is unknown, not pushed to this registration's user, or older than the push expiry is left out of the result, without saying why.

cached_avatar_digests?array<>

Avatar digests the device already holds; their bytes are not sent again. Duplicates are ignored.

Response Body

`application/json`

curl -X POST "https://example.com/v1/public/push-registrations/content/search" \  -H "Content-Type: application/json" \  -d '{    "registration_id": "string",    "content_key": "stringstringstri",    "notification_ids": [      "string"    ]  }'

{
  "items": [
    {
      "notification_id": "string",
      "org_id": "string",
      "conversation_id": "string",
      "sender": {
        "bot_slug": "string",
        "display_name": "string",
        "avatar_digest": "string"
      },
      "preview": {
        "title": "string",
        "body": "string"
      }
    }
  ],
  "avatars": [
    {
      "digest": "string",
      "png_base64": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "error_code": "string",
  "errors": [
    {
      "pointer": "string",
      "detail": "string",
      "type": "string"
    }
  ],
  "trace_id": "string"
}

Authorization

Request Body

Response Body

200application/json

defaultapplication/problem+json

`application/json`