PushizoDocs
API referansı

Bildirim kutusu

Bildirim kutusu — 4 işlem (GET /v1/apps/{appId}/users/by/{label}/{value}/inbox, POST /v1/apps/{appId}/users/by/{label}/{value}/inbox/read-all, POST /v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId}/read, …). OpenAPI 3.1.0 sözleşmesinden üretilir.

Kullanıcının bildirim kutusu: listeleme, okundu işaretleme, tümünü okundu yapma ve arşivleme.

Taban adres: https://api.pushizo.com · Etiket: inbox · Etkileşimli belge (Scalar)

İşlemler

YöntemYolİşlem
GET/v1/apps/{appId}/users/by/{label}/{value}/inboxKullanıcının bildirim kutusu (okunmamış sayısı dahil)
POST/v1/apps/{appId}/users/by/{label}/{value}/inbox/read-allTümünü okundu işaretle
POST/v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId}/readOkundu işaretle
DELETE/v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId}Kutudan kaldır (arşivle)

Ayrıntılar

Kullanıcının bildirim kutusu (okunmamış sayısı dahil)

GET/v1/apps/{appId}/users/by/{label}/{value}/inboxDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam users:read (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
labelyolstringEvet"external_id"
valueyolstringEvet"user_42"
limitsorguintegerHayırVarsayılan: 50; Aralık: 1–20050
cursorsorgustringHayırUzunluk: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
include_archivedsorguenumHayırDeğerler: "true", "false""true"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: InboxPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].message_idstring | nullEvet
data[].titlestring | nullEvet
data[].bodystring | nullEvet
data[].urlstring | nullEvet
data[].image_urlstring | nullEvet
data[].datamap<string, string>Evet
data[].readbooleanEvet
data[].read_atstring | nullEvet
data[].archived_atstring | nullEvet
data[].expires_atstring | nullEvet
data[].created_atstringEvet
unread_countintegerEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Örnek yanıt:

{
  "data": [
    {
      "url": "https://example.com/orders/1001",
      "data": {
        "order_id": "1001"
      },
      "id": "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "title": "Siparişiniz yola çıktı",
      "body": "Takip bağlantısı içeride",
      "image_url": "https://example.com/orders/1001",
      "read": true,
      "read_at": "örnek",
      "archived_at": "örnek",
      "expires_at": "örnek",
      "created_at": "örnek"
    }
  ],
  "unread_count": 1,
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/by/external_id/user_42/inbox?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Tümünü okundu işaretle

POST/v1/apps/{appId}/users/by/{label}/{value}/inbox/read-allDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam users:write (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
labelyolstringEvet"external_id"
valueyolstringEvet"user_42"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: InboxReadAllResult

AlanTürZorunluAçıklama
updatedintegerEvet
unread_countintegerEvet

Örnek yanıt:

{
  "updated": 1,
  "unread_count": 1
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/by/external_id/user_42/inbox/read-all" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Okundu işaretle

POST/v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId}/readDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam users:write (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
labelyolstringEvet"external_id"
valueyolstringEvet"user_42"
itemIdyolstringEvet"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: InboxItem

AlanTürZorunluAçıklama
idstringEvet
message_idstring | nullEvet
titlestring | nullEvet
bodystring | nullEvet
urlstring | nullEvet
image_urlstring | nullEvet
datamap<string, string>Evet
readbooleanEvet
read_atstring | nullEvet
archived_atstring | nullEvet
expires_atstring | nullEvet
created_atstringEvet

Örnek yanıt:

{
  "url": "https://example.com/orders/1001",
  "data": {
    "order_id": "1001"
  },
  "id": "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "title": "Siparişiniz yola çıktı",
  "body": "Takip bağlantısı içeride",
  "image_url": "https://example.com/orders/1001",
  "read": true,
  "read_at": "örnek",
  "archived_at": "örnek",
  "expires_at": "örnek",
  "created_at": "örnek"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/by/external_id/user_42/inbox/inb_01JD3W5Q7X9K2M4N6P8R0T1V3W/read" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Kutudan kaldır (arşivle)

DELETE/v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId}Dene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam users:write (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
labelyolstringEvet"external_id"
valueyolstringEvet"user_42"
itemIdyolstringEvet"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: Ok

AlanTürZorunluAçıklama
oktrueEvet

Örnek yanıt:

{
  "ok": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/by/external_id/user_42/inbox/inb_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

In-app mesajlar

In-app mesajlar — 7 işlem (GET /v1/apps/{appId}/in-app-messages, POST /v1/apps/{appId}/in-app-messages, GET /v1/apps/{appId}/in-app-messages/{messageId}, …). OpenAPI 3.1.0 sözleşmesinden üretilir.

Kategoriler ve tercihler

Kategoriler ve tercihler — 6 işlem (GET /v1/apps/{appId}/categories, POST /v1/apps/{appId}/categories, PATCH /v1/apps/{appId}/categories/{categoryId}, …). OpenAPI 3.1.0 sözleşmesinden üretilir.

Bu sayfada

İşlemlerAyrıntılarKullanıcının bildirim kutusu (okunmamış sayısı dahil)200 — Başarılı.Tümünü okundu işaretle200 — Başarılı.Okundu işaretle200 — Başarılı.Kutudan kaldır (arşivle)200 — Başarılı.