v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Get Pinned Message Info

get/pinned-messages/

Query parameters

chat_room_idstring required

required field

orderingstring

ordering can be pinned_at to get first pinned messages first, and -pinned_at to get latest pinned messages first

Response

200

countinteger

{"stackTrail":"paths:/pinned-messages/:get:responses:200:content:application/json:schema:properties:next","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/pinned-messages/:get:responses:200:content:application/json:schema:properties:previous","oasType":"schema","type":"unknown"}

Example response

{
  "count": 1,
  "results": [
    {
      "id": "abc917b9-421e-4b21-82f0-624c2fcbd7ff",
      "url": "https://cf-blast.livelikecdn.com/api/v1/pinned-messages/abc917b9-421e-4b21-82f0-624c2fcbd7ff/",
      "message_id": "922f38de-c4b4-49d9-9cce-89759eeac956",
      "message_payload": {
        "id": "922f38de-c4b4-49d9-9cce-89759eeac956",
        "sender_id": "b4d1acab-84b7-449d-8298-a5d55fcc8fce",
        "sender_nickname": "Minty Rusher",
        "sender_profile_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/",
        "created_at": "2021-12-02T06:37:47.416Z",
        "message": "new text",
        "timetoken": "16384270682254224"
      },
      "chat_room_id": "46a975fc-49e1-4fc0-8239-25c566296b5e",
      "pinned_by_id": "b4d1acab-84b7-449d-8298-a5d55fcc8fce",
      "pinned_at": "2021-12-02T06:49:57.602937Z",
      "pinned_by": {
        "id": "b4d1acab-84b7-449d-8298-a5d55fcc8fce",
        "url": "https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/",
        "created_at": "2021-11-23T12:14:24.961109Z",
        "nickname": "Minty Rusher",
        "badges_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/badges/",
        "badge_progress_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/badge-progress/",
        "subscribe_channel": "profile.b4d1acab-84b7-449d-8298-a5d55fcc8fce",
        "chat_room_memberships_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/chat-room-memberships/",
        "reward_item_credit_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-credits/",
        "reward_item_debit_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-debits/",
        "reward_item_balances_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-balances/",
        "reward_item_transfer_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-transfers/",
        "block_profile_url": "https://cf-blast.livelikecdn.com/api/v1/profile-blocks/",
        "blocked_profiles_template_url": "https://cf-blast.livelikecdn.com/api/v1/profile-blocks/?blocked_profile_id={blocked_profile_id}"
      }
    }
  ]
}