PushizoDocs
API referansı

iOS Live Activities

iOS Live Activities — 7 işlem (GET /v1/apps/{appId}/live-activities/types, POST /v1/apps/{appId}/live-activities/types, PATCH /v1/apps/{appId}/live-activities/types/{activityType}, …). OpenAPI 3.1.0 sözleşmesinden üretilir.

iOS Live Activities: etkinlik türü kaydı, şema doğrulaması ve start/update/end push’ları.

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

İşlemler

YöntemYolİşlem
GET/v1/apps/{appId}/live-activities/typesLive Activity türleri
POST/v1/apps/{appId}/live-activities/typesLive Activity türü oluştur
PATCH/v1/apps/{appId}/live-activities/types/{activityType}Live Activity türünü güncelle
DELETE/v1/apps/{appId}/live-activities/types/{activityType}Live Activity türünü sil
POST/v1/apps/{appId}/live-activities/{activityType}/startLive Activity başlat (push-to-start)
POST/v1/apps/{appId}/live-activities/{activityType}/updateLive Activity güncelle
POST/v1/apps/{appId}/live-activities/{activityType}/endLive Activity bitir

Ayrıntılar

Live Activity türleri

GET/v1/apps/{appId}/live-activities/typesDene (etkileşimli API belgesi, yeni sekme)

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

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: LiveActivityTypeList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].namestringEvet
data[].descriptionstring | nullEvet
data[].content_state_schemaobjectEvet
data[].content_state_schema.type"object"Evet
data[].content_state_schema.propertiesmap<string, object>Evet
data[].content_state_schema.requiredarray<string>HayırÖğe: 0–50
data[].attributes_schemaobjectEvet
data[].attributes_schema.type"object"Evet
data[].attributes_schema.propertiesmap<string, object>Evet
data[].attributes_schema.requiredarray<string>HayırÖğe: 0–50
data[].push_to_start_tokensintegerEvet
data[].created_atstringEvet
data[].updated_atstringEvet

Örnek yanıt:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "description": "Sipariş durumu güncellemeleri",
      "content_state_schema": {
        "properties": {
          "order_id": "1001"
        },
        "type": "object",
        "required": [
          "örnek"
        ]
      },
      "attributes_schema": {
        "properties": {
          "order_id": "1001"
        },
        "type": "object",
        "required": [
          "örnek"
        ]
      },
      "push_to_start_tokens": 1,
      "created_at": "örnek",
      "updated_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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/live-activities/types" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Live Activity türü oluştur

POST/v1/apps/{appId}/live-activities/typesDene (etkileşimli API belgesi, yeni sekme)

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

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

İstek gövdesi (zorunlu)

Şema: CreateLiveActivityTypeDto

AlanTürZorunluAçıklama
namestringEvetUzunluk: 1–100
descriptionstringHayırUzunluk: 0–300
content_state_schemaobjectEvet
content_state_schema.type"object"Evet
content_state_schema.propertiesmap<string, object>Evet
content_state_schema.requiredarray<string>HayırÖğe: 0–50
attributes_schemaobjectHayır
attributes_schema.type"object"Evet
attributes_schema.propertiesmap<string, object>Evet
attributes_schema.requiredarray<string>HayırÖğe: 0–50

Örnek:

{
  "name": "Sipariş bildirimleri",
  "content_state_schema": {
    "properties": {
      "order_id": "1001"
    },
    "type": "object",
    "required": [
      "örnek"
    ]
  },
  "description": "Sipariş durumu güncellemeleri",
  "attributes_schema": {
    "properties": {
      "order_id": "1001"
    },
    "type": "object",
    "required": [
      "örnek"
    ]
  }
}

Yanıtlar

201 — Başarılı.

Şema: LiveActivityType

AlanTürZorunluAçıklama
idstringEvet
namestringEvet
descriptionstring | nullEvet
content_state_schemaobjectEvet
content_state_schema.type"object"Evet
content_state_schema.propertiesmap<string, object>Evet
content_state_schema.requiredarray<string>HayırÖğe: 0–50
attributes_schemaobjectEvet
attributes_schema.type"object"Evet
attributes_schema.propertiesmap<string, object>Evet
attributes_schema.requiredarray<string>HayırÖğe: 0–50
push_to_start_tokensintegerEvet
created_atstringEvet
updated_atstringEvet

Örnek yanıt:

{
  "name": "Sipariş bildirimleri",
  "id": "typ_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "content_state_schema": {
    "properties": {
      "order_id": "1001"
    },
    "type": "object",
    "required": [
      "örnek"
    ]
  },
  "attributes_schema": {
    "properties": {
      "order_id": "1001"
    },
    "type": "object",
    "required": [
      "örnek"
    ]
  },
  "push_to_start_tokens": 1,
  "created_at": "örnek",
  "updated_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/live-activities/types" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "content_state_schema": {
    "properties": {
      "order_id": "1001"
    },
    "type": "object",
    "required": [
      "örnek"
    ]
  },
  "description": "Sipariş durumu güncellemeleri",
  "attributes_schema": {
    "properties": {
      "order_id": "1001"
    },
    "type": "object",
    "required": [
      "örnek"
    ]
  }
}'

Live Activity türünü güncelle

PATCH/v1/apps/{appId}/live-activities/types/{activityType}Dene (etkileşimli API belgesi, yeni sekme)

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

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
activityTypeyolstringEvet"order_tracking"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

İstek gövdesi (zorunlu)

Şema: UpdateLiveActivityTypeDto

AlanTürZorunluAçıklama
descriptionstring | nullHayır
content_state_schemaobjectHayır
content_state_schema.type"object"Evet
content_state_schema.propertiesmap<string, object>Evet
content_state_schema.requiredarray<string>HayırÖğe: 0–50
attributes_schemaobjectHayır
attributes_schema.type"object"Evet
attributes_schema.propertiesmap<string, object>Evet
attributes_schema.requiredarray<string>HayırÖğe: 0–50

Örnek:

{
  "description": "Sipariş durumu güncellemeleri",
  "content_state_schema": {
    "properties": {
      "order_id": "1001"
    },
    "type": "object",
    "required": [
      "örnek"
    ]
  },
  "attributes_schema": {
    "properties": {
      "order_id": "1001"
    },
    "type": "object",
    "required": [
      "örnek"
    ]
  }
}

Yanıtlar

200 — Başarılı.

Şema: LiveActivityType

AlanTürZorunluAçıklama
idstringEvet
namestringEvet
descriptionstring | nullEvet
content_state_schemaobjectEvet
content_state_schema.type"object"Evet
content_state_schema.propertiesmap<string, object>Evet
content_state_schema.requiredarray<string>HayırÖğe: 0–50
attributes_schemaobjectEvet
attributes_schema.type"object"Evet
attributes_schema.propertiesmap<string, object>Evet
attributes_schema.requiredarray<string>HayırÖğe: 0–50
push_to_start_tokensintegerEvet
created_atstringEvet
updated_atstringEvet

Örnek yanıt:

{
  "name": "Sipariş bildirimleri",
  "id": "typ_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "content_state_schema": {
    "properties": {
      "order_id": "1001"
    },
    "type": "object",
    "required": [
      "örnek"
    ]
  },
  "attributes_schema": {
    "properties": {
      "order_id": "1001"
    },
    "type": "object",
    "required": [
      "örnek"
    ]
  },
  "push_to_start_tokens": 1,
  "created_at": "örnek",
  "updated_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 PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/live-activities/types/order_tracking" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Sipariş durumu güncellemeleri",
  "content_state_schema": {
    "properties": {
      "order_id": "1001"
    },
    "type": "object",
    "required": [
      "örnek"
    ]
  },
  "attributes_schema": {
    "properties": {
      "order_id": "1001"
    },
    "type": "object",
    "required": [
      "örnek"
    ]
  }
}'

Live Activity türünü sil

DELETE/v1/apps/{appId}/live-activities/types/{activityType}Dene (etkileşimli API belgesi, yeni sekme)

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

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
activityTypeyolstringEvet"order_tracking"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: LiveActivityTokenResult

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/live-activities/types/order_tracking" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Live Activity başlat (push-to-start)

POST/v1/apps/{appId}/live-activities/{activityType}/startDene (etkileşimli API belgesi, yeni sekme)

Hedefteki iOS aboneliklerinin push-to-start belirteçleriyle etkinliği uzaktan başlatır (iOS 17.2+). attributes ve content_state türün şemasına uymalıdır. Dönen activity_id ile sonraki update/end yapılır.

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

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
activityTypeyolstringEvet"order_tracking"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

İstek gövdesi (zorunlu)

Şema: StartLiveActivityDto

AlanTürZorunluAçıklama
activity_idstringHayırUzunluk: 1–100
attributesmap<string, string | number | boolean>Hayır
targetobjectEvet
target.include_external_idsarray<string>HayırÖğe: 0–2000
target.include_subscription_idsarray<string>HayırÖğe: 0–2000
target.included_segmentsarray<string>HayırÖğe: 0–20
target.allbooleanHayır
content_statemap<string, string | number | boolean>Evet
alertobjectHayır
alert.titlemap<string, string>Hayır
alert.bodymap<string, string>Hayır
alert.soundstringHayırUzunluk: 0–100
stale_dateintegerHayırAralık: 0–4102444800
dismissal_dateintegerHayırAralık: 0–4102444800
relevance_scorenumberHayırAralık: 0–1
priority5 | 10Hayır
namestringHayırUzunluk: 0–200

Örnek:

{
  "target": {
    "include_external_ids": [
      "user_42"
    ],
    "include_subscription_ids": [
      "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    ],
    "included_segments": [
      "örnek"
    ]
  },
  "content_state": {
    "key": "user_42"
  },
  "name": "Sipariş bildirimleri",
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "attributes": {
    "key": "user_42"
  },
  "alert": {
    "title": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "body": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "sound": "örnek"
  },
  "stale_date": 1
}

Yanıtlar

202 — Başarılı.

Şema: LiveActivitySendResult

AlanTürZorunluAçıklama
message_idstringEvet
activity_idstringEvet
eventenumEvetDeğerler: "start", "update", "end"
recipients_estimateintegerEvet

Örnek yanıt:

{
  "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "event": "start",
  "recipients_estimate": 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/live-activities/order_tracking/start" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "target": {
    "include_external_ids": [
      "user_42"
    ],
    "include_subscription_ids": [
      "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    ],
    "included_segments": [
      "örnek"
    ]
  },
  "content_state": {
    "key": "user_42"
  },
  "name": "Sipariş bildirimleri",
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "attributes": {
    "key": "user_42"
  },
  "alert": {
    "title": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "body": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "sound": "örnek"
  },
  "stale_date": 1
}'

Live Activity güncelle

POST/v1/apps/{appId}/live-activities/{activityType}/updateDene (etkileşimli API belgesi, yeni sekme)

Etkinliğin cihazlardan bildirilen güncelleme belirteçlerine yeni içerik durumu gönderir. Sessiz saat ve frekans sınırı uygulanmaz; priority 5 Apple bütçesini korur.

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

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
activityTypeyolstringEvet"order_tracking"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

İstek gövdesi (zorunlu)

Şema: UpdateLiveActivityDto

AlanTürZorunluAçıklama
activity_idstringEvetUzunluk: 1–100
content_statemap<string, string | number | boolean>Evet
alertobjectHayır
alert.titlemap<string, string>Hayır
alert.bodymap<string, string>Hayır
alert.soundstringHayırUzunluk: 0–100
stale_dateintegerHayırAralık: 0–4102444800
dismissal_dateintegerHayırAralık: 0–4102444800
relevance_scorenumberHayırAralık: 0–1
priority5 | 10Hayır
namestringHayırUzunluk: 0–200

Örnek:

{
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "content_state": {
    "key": "user_42"
  },
  "name": "Sipariş bildirimleri",
  "alert": {
    "title": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "body": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "sound": "örnek"
  },
  "stale_date": 1,
  "dismissal_date": 1,
  "relevance_score": 1.5
}

Yanıtlar

202 — Başarılı.

Şema: LiveActivitySendResult

AlanTürZorunluAçıklama
message_idstringEvet
activity_idstringEvet
eventenumEvetDeğerler: "start", "update", "end"
recipients_estimateintegerEvet

Örnek yanıt:

{
  "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "event": "start",
  "recipients_estimate": 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/live-activities/order_tracking/update" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "content_state": {
    "key": "user_42"
  },
  "name": "Sipariş bildirimleri",
  "alert": {
    "title": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "body": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "sound": "örnek"
  },
  "stale_date": 1,
  "dismissal_date": 1,
  "relevance_score": 1.5
}'

Live Activity bitir

POST/v1/apps/{appId}/live-activities/{activityType}/endDene (etkileşimli API belgesi, yeni sekme)

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

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
activityTypeyolstringEvet"order_tracking"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

İstek gövdesi (zorunlu)

Şema: EndLiveActivityDto

AlanTürZorunluAçıklama
activity_idstringEvetUzunluk: 1–100
content_statemap<string, string | number | boolean>Hayır
alertobjectHayır
alert.titlemap<string, string>Hayır
alert.bodymap<string, string>Hayır
alert.soundstringHayırUzunluk: 0–100
stale_dateintegerHayırAralık: 0–4102444800
dismissal_dateintegerHayırAralık: 0–4102444800
relevance_scorenumberHayırAralık: 0–1
priority5 | 10Hayır
namestringHayırUzunluk: 0–200

Örnek:

{
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "name": "Sipariş bildirimleri",
  "content_state": {
    "key": "user_42"
  },
  "alert": {
    "title": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "body": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "sound": "örnek"
  },
  "stale_date": 1,
  "dismissal_date": 1
}

Yanıtlar

202 — Başarılı.

Şema: LiveActivitySendResult

AlanTürZorunluAçıklama
message_idstringEvet
activity_idstringEvet
eventenumEvetDeğerler: "start", "update", "end"
recipients_estimateintegerEvet

Örnek yanıt:

{
  "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "event": "start",
  "recipients_estimate": 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/live-activities/order_tracking/end" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "name": "Sipariş bildirimleri",
  "content_state": {
    "key": "user_42"
  },
  "alert": {
    "title": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "body": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "sound": "örnek"
  },
  "stale_date": 1,
  "dismissal_date": 1
}'
Sekmesi olmayan dillerde bu işlem için SDK metodu yoktur; cURL örneğini kullanın.

Suppression list

Suppression list — 3 işlem (GET /v1/apps/{appId}/suppressions, POST /v1/apps/{appId}/suppressions, DELETE /v1/apps/{appId}/suppressions/{suppressionId}). OpenAPI 3.1.0 sözleşmesinden üretilir.

Konuşmalar (WhatsApp, iki yönlü SMS)

Konuşmalar (WhatsApp, iki yönlü SMS) — 11 işlem (GET /v1/apps/{appId}/conversations, GET /v1/apps/{appId}/conversations/{conversationId}, GET /v1/apps/{appId}/conversations/{conversationId}/messages, …). OpenAPI 3.1.0 sözleşmesinden üretilir.

Bu sayfada

İşlemlerAyrıntılarLive Activity türleri200 — Başarılı.Live Activity türü oluştur201 — Başarılı.Live Activity türünü güncelle200 — Başarılı.Live Activity türünü sil200 — Başarılı.Live Activity başlat (push-to-start)202 — Başarılı.Live Activity güncelle202 — Başarılı.Live Activity bitir202 — Başarılı.