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.

WhatsApp şablonları ve iki yönlü SMS/WhatsApp konuşmaları, anahtar sözcük (keyword) otomasyonları.

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

İşlemler

Yöntem	Yol	İşlem
`GET`	`/v1/apps/{appId}/conversations`	Konuşmalar (SMS, WhatsApp, RCS; son mesaja göre; kanal/durum/okunmamış/kişi filtresi)
`GET`	`/v1/apps/{appId}/conversations/{conversationId}`	Konuşma (WhatsApp oturum penceresi ve açık rıza durumu dahil)
`GET`	`/v1/apps/{appId}/conversations/{conversationId}/messages`	Konuşma mesajları (yeniden eskiye; giden mesaj durumu teslimattan)
`POST`	`/v1/apps/{appId}/conversations/{conversationId}/messages`	Yanıt gönder. WhatsApp: açık rıza zorunlu; son gelen mesajdan 24 saat içinde metin/medya, pencere dışında yalnızca onaylı şablon (aksi 422 WHATSAPP_WINDOW_CLOSED).
`POST`	`/v1/apps/{appId}/conversations/{conversationId}/read`	Gelen mesajları okundu işaretle
`GET`	`/v1/apps/{appId}/sms-keywords`	İki yönlü mesaj anahtar sözcükleri (org geneli + bu app) ve yasal (ayrılmış) sözcükler
`POST`	`/v1/apps/{appId}/sms-keywords`	Anahtar sözcük oluştur (tag ekle/kaldır, olay → journey tetiği, otomatik yanıt, abonelik)
`PATCH`	`/v1/apps/{appId}/sms-keywords/{keywordId}`	Anahtar sözcüğü güncelle
`DELETE`	`/v1/apps/{appId}/sms-keywords/{keywordId}`	Anahtar sözcüğü sil
`GET`	`/v1/apps/{appId}/whatsapp/templates`	WhatsApp şablonları (Meta onay durumu ile)
`POST`	`/v1/apps/{appId}/whatsapp/templates/sync`	WhatsApp şablonlarını Meta Graph API’den senkronla

Ayrıntılar

Konuşmalar (SMS, WhatsApp, RCS; son mesaja göre; kanal/durum/okunmamış/kişi filtresi)

GET/v1/apps/{appId}/conversationsDene

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

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`limit`	sorgu	`integer`	Hayır	Varsayılan: `50`; Aralık: 1–200	`50`
`cursor`	sorgu	`string`	Hayır	Uzunluk: 1–∞	`"eyJpZCI6Im1zZ18wMUpE…"`
`channel`	sorgu	`enum`	Hayır	Değerler: `"sms"`, `"whatsapp"`, `"rcs"`	`"sms"`
`status`	sorgu	`enum`	Hayır	Değerler: `"open"`, `"closed"`	`"open"`
`unread`	sorgu	`enum`	Hayır	Değerler: `"true"`, `"false"`	`"true"`
`q`	sorgu	`string`	Hayır	Uzunluk: 2–255	`"ayse"`
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

Yanıtlar

200 — Başarılı.

Şema: ConversationPage

Alan	Tür	Zorunlu	Açıklama
`data`	`array<object>`	Evet
`data[].id`	`string`	Evet
`data[].channel`	`enum`	Evet	Değerler: `"sms"`, `"whatsapp"`, `"rcs"`
`data[].status`	`enum`	Evet	Değerler: `"open"`, `"closed"`
`data[].subscription_id`	`string`	Evet
`data[].subscription_status`	`string`	Evet
`data[].user_id`	`string \| null`	Evet
`data[].external_id`	`string \| null`	Evet
`data[].contact`	`string`	Evet
`data[].opted_in`	`boolean`	Evet
`data[].last_message_at`	`string`	Evet
`data[].last_inbound_at`	`string \| null`	Evet
`data[].last_direction`	`enum \| null`	Evet
`data[].last_message_preview`	`string \| null`	Evet
`data[].unread_count`	`integer`	Evet
`data[].window`	`object \| null`	Evet
`data[].created_at`	`string`	Evet
`next_cursor`	`string \| null`	Evet
`has_more`	`boolean`	Evet

Örnek yanıt:

{
  "data": [
    {
      "channel": "sms",
      "status": "open",
      "id": "cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "subscription_status": "örnek",
      "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "external_id": "user_42",
      "contact": "örnek",
      "opted_in": true,
      "last_message_at": "örnek",
      "last_inbound_at": "örnek",
      "last_direction": "inbound",
      "last_message_preview": "örnek",
      "unread_count": 1,
      "window": {
        "open": true,
        "expires_at": "örnek"
      },
      "created_at": "örnek"
    }
  ],
  "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/conversations?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Konuşma (WhatsApp oturum penceresi ve açık rıza durumu dahil)

GET/v1/apps/{appId}/conversations/{conversationId}Dene

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

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`conversationId`	yol	`string`	Evet		`"cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W"`
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

Yanıtlar

200 — Başarılı.

Şema: Conversation

Alan	Tür	Zorunlu	Açıklama
`id`	`string`	Evet
`channel`	`enum`	Evet	Değerler: `"sms"`, `"whatsapp"`, `"rcs"`
`status`	`enum`	Evet	Değerler: `"open"`, `"closed"`
`subscription_id`	`string`	Evet
`subscription_status`	`string`	Evet
`user_id`	`string \| null`	Evet
`external_id`	`string \| null`	Evet
`contact`	`string`	Evet
`opted_in`	`boolean`	Evet
`last_message_at`	`string`	Evet
`last_inbound_at`	`string \| null`	Evet
`last_direction`	`enum \| null`	Evet
`last_message_preview`	`string \| null`	Evet
`unread_count`	`integer`	Evet
`window`	`object \| null`	Evet
`created_at`	`string`	Evet

Örnek yanıt:

{
  "channel": "sms",
  "status": "open",
  "id": "cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subscription_status": "örnek",
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "external_id": "user_42",
  "contact": "örnek",
  "opted_in": true,
  "last_message_at": "örnek",
  "last_inbound_at": "örnek",
  "last_direction": "inbound",
  "last_message_preview": "örnek",
  "unread_count": 1,
  "window": {
    "open": true,
    "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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/conversations/cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Konuşma mesajları (yeniden eskiye; giden mesaj durumu teslimattan)

GET/v1/apps/{appId}/conversations/{conversationId}/messagesDene

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

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`conversationId`	yol	`string`	Evet		`"cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W"`
`limit`	sorgu	`integer`	Hayır	Varsayılan: `50`; Aralık: 1–200	`50`
`cursor`	sorgu	`string`	Hayır	Uzunluk: 1–∞	`"eyJpZCI6Im1zZ18wMUpE…"`
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

Yanıtlar

200 — Başarılı.

Şema: ConversationMessagePage

Alan	Tür	Zorunlu	Açıklama
`data`	`array<object>`	Evet
`data[].id`	`string`	Evet
`data[].direction`	`enum`	Evet	Değerler: `"inbound"`, `"outbound"`
`data[].status`	`string`	Evet
`data[].body`	`string \| null`	Evet
`data[].content`	`map<string, any>`	Evet
`data[].message_id`	`string \| null`	Evet
`data[].delivery_id`	`string \| null`	Evet
`data[].sent_by`	`string \| null`	Evet
`data[].error_code`	`string \| null`	Evet
`data[].read_at`	`string \| null`	Evet
`data[].created_at`	`string`	Evet
`next_cursor`	`string \| null`	Evet
`has_more`	`boolean`	Evet

Örnek yanıt:

{
  "data": [
    {
      "status": "örnek",
      "id": "cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "direction": "inbound",
      "body": "Takip bağlantısı içeride",
      "content": {
        "contents": {
          "tr": "Siparişiniz yola çıktı"
        }
      },
      "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "delivery_id": "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "sent_by": "örnek",
      "error_code": "örnek",
      "read_at": "örnek",
      "created_at": "örnek"
    }
  ],
  "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/conversations/cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W/messages?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Yanıt gönder. WhatsApp: açık rıza zorunlu; son gelen mesajdan 24 saat içinde metin/medya, pencere dışında yalnızca onaylı şablon (aksi 422 WHATSAPP_WINDOW_CLOSED).

POST/v1/apps/{appId}/conversations/{conversationId}/messagesDene

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

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`conversationId`	yol	`string`	Evet		`"cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W"`
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

İstek gövdesi (zorunlu)

Şema: ConversationReplyDto

Alan	Tür	Zorunlu	Açıklama
`text`	`string`	Hayır	Uzunluk: 1–4096
`template`	`object`	Hayır
`template.name`	`string`	Evet
`template.language`	`string`	Evet
`template.header`	`object`	Hayır
`template.body_params`	`array<string>`	Hayır	Öğe: 0–20
`template.button_params`	`array<object>`	Hayır	Öğe: 0–10
`template.button_params[].index`	`integer`	Evet	Aralık: 0–9
`template.button_params[].sub_type`	`enum`	Evet	Değerler: `"url"`, `"quick_reply"`, `"copy_code"`
`template.button_params[].value`	`string`	Evet	Uzunluk: 1–256
`media`	`object`	Hayır
`media.type`	`enum`	Evet	Değerler: `"image"`, `"video"`, `"document"`, `"audio"`
`media.url`	`string (url)`	Evet	Uzunluk: 0–2000
`media.filename`	`string`	Hayır	Uzunluk: 1–240
`interactive`	`object`	Hayır
`interactive.type`	`enum`	Evet	Değerler: `"button"`, `"list"`
`interactive.header`	`string`	Hayır	Uzunluk: 1–60
`interactive.footer`	`string`	Hayır	Uzunluk: 1–60
`interactive.buttons`	`array<object>`	Hayır	Öğe: 1–3
`interactive.buttons[].id`	`string`	Evet	Uzunluk: 1–256
`interactive.buttons[].title`	`string`	Evet	Uzunluk: 1–20
`interactive.list`	`object`	Hayır
`interactive.list.button`	`string`	Evet	Uzunluk: 1–20
`interactive.list.sections`	`array<object>`	Evet	Öğe: 1–10
`interactive.list.sections[].title`	`string`	Hayır	Uzunluk: 1–24
`interactive.list.sections[].rows`	`array<object>`	Evet	Öğe: 1–10
`interactive.list.sections[].rows[].id`	`string`	Evet	Uzunluk: 1–200
`interactive.list.sections[].rows[].title`	`string`	Evet	Uzunluk: 1–24
`interactive.list.sections[].rows[].description`	`string`	Hayır	Uzunluk: 1–72

Örnek:

{
  "text": "Takip bağlantısı içeride",
  "template": {
    "name": "Sipariş bildirimleri",
    "language": "tr",
    "header": {
      "type": "text",
      "text": "Takip bağlantısı içeride"
    },
    "body_params": [
      "örnek"
    ],
    "button_params": [
      {
        "index": 1,
        "sub_type": "url",
        "value": "user_42"
      }
    ]
  },
  "media": {
    "url": "https://example.com/orders/1001",
    "type": "image",
    "filename": "örnek"
  },
  "interactive": {
    "type": "button",
    "header": "örnek",
    "footer": "örnek",
    "buttons": [
      {
        "id": "cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "title": "Siparişiniz yola çıktı"
      }
    ]
  }
}

Yanıtlar

202 — Başarılı.

Şema: ConversationReplyResult

Alan	Tür	Zorunlu	Açıklama
`message_id`	`string`	Evet
`conversation_message`	`object`	Evet
`conversation_message.id`	`string`	Evet
`conversation_message.direction`	`enum`	Evet	Değerler: `"inbound"`, `"outbound"`
`conversation_message.status`	`string`	Evet
`conversation_message.body`	`string \| null`	Evet
`conversation_message.content`	`map<string, any>`	Evet
`conversation_message.message_id`	`string \| null`	Evet
`conversation_message.delivery_id`	`string \| null`	Evet
`conversation_message.sent_by`	`string \| null`	Evet
`conversation_message.error_code`	`string \| null`	Evet
`conversation_message.read_at`	`string \| null`	Evet
`conversation_message.created_at`	`string`	Evet

Örnek yanıt:

{
  "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "conversation_message": {
    "status": "örnek",
    "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "direction": "inbound",
    "body": "Takip bağlantısı içeride",
    "content": {
      "contents": {
        "tr": "Siparişiniz yola çıktı"
      }
    },
    "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "delivery_id": "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "sent_by": "örnek",
    "error_code": "örnek",
    "read_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/conversations/cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W/messages" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "Takip bağlantısı içeride",
  "template": {
    "name": "Sipariş bildirimleri",
    "language": "tr",
    "header": {
      "type": "text",
      "text": "Takip bağlantısı içeride"
    },
    "body_params": [
      "örnek"
    ],
    "button_params": [
      {
        "index": 1,
        "sub_type": "url",
        "value": "user_42"
      }
    ]
  },
  "media": {
    "url": "https://example.com/orders/1001",
    "type": "image",
    "filename": "örnek"
  },
  "interactive": {
    "type": "button",
    "header": "örnek",
    "footer": "örnek",
    "buttons": [
      {
        "id": "cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "title": "Siparişiniz yola çıktı"
      }
    ]
  }
}'

Gelen mesajları okundu işaretle

POST/v1/apps/{appId}/conversations/{conversationId}/readDene

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

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`conversationId`	yol	`string`	Evet		`"cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W"`
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

Yanıtlar

200 — Başarılı.

Şema: Conversation

Alan	Tür	Zorunlu	Açıklama
`id`	`string`	Evet
`channel`	`enum`	Evet	Değerler: `"sms"`, `"whatsapp"`, `"rcs"`
`status`	`enum`	Evet	Değerler: `"open"`, `"closed"`
`subscription_id`	`string`	Evet
`subscription_status`	`string`	Evet
`user_id`	`string \| null`	Evet
`external_id`	`string \| null`	Evet
`contact`	`string`	Evet
`opted_in`	`boolean`	Evet
`last_message_at`	`string`	Evet
`last_inbound_at`	`string \| null`	Evet
`last_direction`	`enum \| null`	Evet
`last_message_preview`	`string \| null`	Evet
`unread_count`	`integer`	Evet
`window`	`object \| null`	Evet
`created_at`	`string`	Evet

Örnek yanıt:

{
  "channel": "sms",
  "status": "open",
  "id": "cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subscription_status": "örnek",
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "external_id": "user_42",
  "contact": "örnek",
  "opted_in": true,
  "last_message_at": "örnek",
  "last_inbound_at": "örnek",
  "last_direction": "inbound",
  "last_message_preview": "örnek",
  "unread_count": 1,
  "window": {
    "open": true,
    "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/conversations/cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W/read" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

İki yönlü mesaj anahtar sözcükleri (org geneli + bu app) ve yasal (ayrılmış) sözcükler

GET/v1/apps/{appId}/sms-keywordsDene

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

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

Yanıtlar

200 — Başarılı.

Şema: SmsKeywordList

Alan	Tür	Zorunlu	Açıklama
`data`	`array<object>`	Evet
`data[].id`	`string`	Evet
`data[].keyword`	`string`	Evet
`data[].scope`	`enum`	Evet	Değerler: `"org"`, `"app"`
`data[].app_id`	`string \| null`	Evet
`data[].channels`	`array<enum>`	Evet
`data[].actions`	`map<string, any>`	Evet
`data[].enabled`	`boolean`	Evet
`data[].description`	`string \| null`	Evet
`data[].created_at`	`string`	Evet
`data[].updated_at`	`string`	Evet
`reserved`	`array<string>`	Evet

Örnek yanıt:

{
  "data": [
    {
      "channels": [
        "sms"
      ],
      "enabled": true,
      "id": "cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "keyword": "örnek",
      "scope": "org",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "actions": {
        "key": "örnek"
      },
      "description": "Sipariş durumu güncellemeleri",
      "created_at": "örnek",
      "updated_at": "örnek"
    }
  ],
  "reserved": [
    "ö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/sms-keywords" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Anahtar sözcük oluştur (tag ekle/kaldır, olay → journey tetiği, otomatik yanıt, abonelik)

POST/v1/apps/{appId}/sms-keywordsDene

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

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

İstek gövdesi (zorunlu)

Şema: CreateKeywordDto

Alan	Tür	Zorunlu	Açıklama
`keyword`	`string`	Evet	Uzunluk: 1–30
`scope`	`enum`	Hayır	Değerler: `"org"`, `"app"`
`channels`	`array<enum>`	Hayır	Öğe: 1–3
`actions`	`object`	Evet
`actions.add_tags`	`map<string, string>`	Hayır
`actions.remove_tags`	`array<string>`	Hayır	Öğe: 0–50
`actions.event`	`object`	Hayır
`actions.event.name`	`string`	Evet
`actions.event.properties`	`map<string, string>`	Hayır
`actions.reply`	`object`	Hayır
`actions.reply.text`	`string`	Evet	Uzunluk: 1–1600
`actions.opt_in`	`boolean`	Hayır
`enabled`	`boolean`	Hayır
`description`	`string`	Hayır	Uzunluk: 0–300

Örnek:

{
  "keyword": "örnek",
  "actions": {
    "add_tags": {
      "key": "user_42"
    },
    "remove_tags": [
      "örnek"
    ],
    "event": {
      "name": "purchase",
      "properties": {
        "order_id": "1001"
      }
    }
  },
  "channels": [
    "sms"
  ],
  "enabled": true,
  "scope": "org",
  "description": "Sipariş durumu güncellemeleri"
}

Yanıtlar

201 — Başarılı.

Şema: SmsKeyword

Alan	Tür	Zorunlu	Açıklama
`id`	`string`	Evet
`keyword`	`string`	Evet
`scope`	`enum`	Evet	Değerler: `"org"`, `"app"`
`app_id`	`string \| null`	Evet
`channels`	`array<enum>`	Evet
`actions`	`map<string, any>`	Evet
`enabled`	`boolean`	Evet
`description`	`string \| null`	Evet
`created_at`	`string`	Evet
`updated_at`	`string`	Evet

Örnek yanıt:

{
  "channels": [
    "sms"
  ],
  "enabled": true,
  "id": "kw_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "keyword": "örnek",
  "scope": "org",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "actions": {
    "key": "örnek"
  },
  "description": "Sipariş durumu güncellemeleri",
  "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/sms-keywords" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keyword": "örnek",
  "actions": {
    "add_tags": {
      "key": "user_42"
    },
    "remove_tags": [
      "örnek"
    ],
    "event": {
      "name": "purchase",
      "properties": {
        "order_id": "1001"
      }
    }
  },
  "channels": [
    "sms"
  ],
  "enabled": true,
  "scope": "org",
  "description": "Sipariş durumu güncellemeleri"
}'

Anahtar sözcüğü güncelle

PATCH/v1/apps/{appId}/sms-keywords/{keywordId}Dene

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

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`keywordId`	yol	`string`	Evet		`"kw_01JD3W5Q7X9K2M4N6P8R0T1V3W"`
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

İstek gövdesi (zorunlu)

Şema: UpdateKeywordDto

Alan	Tür	Zorunlu	Açıklama
`keyword`	`string`	Hayır	Uzunluk: 1–30
`channels`	`array<enum>`	Hayır	Öğe: 1–3
`actions`	`object`	Hayır
`actions.add_tags`	`map<string, string>`	Hayır
`actions.remove_tags`	`array<string>`	Hayır	Öğe: 0–50
`actions.event`	`object`	Hayır
`actions.event.name`	`string`	Evet
`actions.event.properties`	`map<string, string>`	Hayır
`actions.reply`	`object`	Hayır
`actions.reply.text`	`string`	Evet	Uzunluk: 1–1600
`actions.opt_in`	`boolean`	Hayır
`enabled`	`boolean`	Hayır
`description`	`string \| null`	Hayır

Örnek:

{
  "channels": [
    "sms"
  ],
  "enabled": true,
  "keyword": "örnek",
  "actions": {
    "add_tags": {
      "key": "user_42"
    },
    "remove_tags": [
      "örnek"
    ],
    "event": {
      "name": "purchase",
      "properties": {
        "order_id": "1001"
      }
    }
  },
  "description": "Sipariş durumu güncellemeleri"
}

Yanıtlar

200 — Başarılı.

Şema: SmsKeyword

Alan	Tür	Zorunlu	Açıklama
`id`	`string`	Evet
`keyword`	`string`	Evet
`scope`	`enum`	Evet	Değerler: `"org"`, `"app"`
`app_id`	`string \| null`	Evet
`channels`	`array<enum>`	Evet
`actions`	`map<string, any>`	Evet
`enabled`	`boolean`	Evet
`description`	`string \| null`	Evet
`created_at`	`string`	Evet
`updated_at`	`string`	Evet

Örnek yanıt:

{
  "channels": [
    "sms"
  ],
  "enabled": true,
  "id": "kw_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "keyword": "örnek",
  "scope": "org",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "actions": {
    "key": "örnek"
  },
  "description": "Sipariş durumu güncellemeleri",
  "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/sms-keywords/kw_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "channels": [
    "sms"
  ],
  "enabled": true,
  "keyword": "örnek",
  "actions": {
    "add_tags": {
      "key": "user_42"
    },
    "remove_tags": [
      "örnek"
    ],
    "event": {
      "name": "purchase",
      "properties": {
        "order_id": "1001"
      }
    }
  },
  "description": "Sipariş durumu güncellemeleri"
}'

Anahtar sözcüğü sil

DELETE/v1/apps/{appId}/sms-keywords/{keywordId}Dene

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

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`keywordId`	yol	`string`	Evet		`"kw_01JD3W5Q7X9K2M4N6P8R0T1V3W"`
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

Yanıtlar

200 — Başarılı.

Şema: Ok

Alan	Tür	Zorunlu	Açıklama
`ok`	`true`	Evet

Ö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/sms-keywords/kw_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

WhatsApp şablonları (Meta onay durumu ile)

GET/v1/apps/{appId}/whatsapp/templatesDene

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

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`status`	sorgu	`string`	Hayır	Uzunluk: 0–30	`"örnek"`
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

Yanıtlar

200 — Başarılı.

Şema: WhatsAppTemplateList

Alan	Tür	Zorunlu
`data`	`array<object>`	Evet
`data[].id`	`string`	Evet
`data[].external_id`	`string \| null`	Evet
`data[].name`	`string`	Evet
`data[].language`	`string`	Evet
`data[].category`	`string`	Evet
`data[].status`	`string`	Evet
`data[].components`	`array<map<string, any>>`	Evet
`data[].body_params`	`integer`	Evet
`data[].rejected_reason`	`string \| null`	Evet
`data[].quality_score`	`string \| null`	Evet
`data[].synced_at`	`string`	Evet

Örnek yanıt:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "status": "örnek",
      "id": "cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "external_id": "user_42",
      "language": "tr",
      "category": "örnek",
      "components": [
        {
          "key": "örnek"
        }
      ],
      "body_params": 1,
      "rejected_reason": "örnek",
      "quality_score": "örnek",
      "synced_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/whatsapp/templates" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

WhatsApp şablonlarını Meta Graph API’den senkronla

POST/v1/apps/{appId}/whatsapp/templates/syncDene

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

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

Yanıtlar

200 — Başarılı.

Şema: WhatsAppTemplateSync

Alan	Tür	Zorunlu
`total`	`integer`	Evet
`removed`	`integer`	Evet
`data`	`array<object>`	Evet
`data[].id`	`string`	Evet
`data[].external_id`	`string \| null`	Evet
`data[].name`	`string`	Evet
`data[].language`	`string`	Evet
`data[].category`	`string`	Evet
`data[].status`	`string`	Evet
`data[].components`	`array<map<string, any>>`	Evet
`data[].body_params`	`integer`	Evet
`data[].rejected_reason`	`string \| null`	Evet
`data[].quality_score`	`string \| null`	Evet
`data[].synced_at`	`string`	Evet

Örnek yanıt:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "status": "örnek",
      "id": "cnv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "external_id": "user_42",
      "language": "tr",
      "category": "örnek",
      "components": [
        {
          "key": "örnek"
        }
      ],
      "body_params": 1,
      "rejected_reason": "örnek",
      "quality_score": "örnek",
      "synced_at": "örnek"
    }
  ],
  "total": 1,
  "removed": 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/whatsapp/templates/sync" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

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

İşlemlerBağlantıyı kopyala

AyrıntılarBağlantıyı kopyala

Konuşmalar (SMS, WhatsApp, RCS; son mesaja göre; kanal/durum/okunmamış/kişi filtresi)Bağlantıyı kopyala

200 — Başarılı.Bağlantıyı kopyala

Konuşma (WhatsApp oturum penceresi ve açık rıza durumu dahil)Bağlantıyı kopyala

200 — Başarılı.Bağlantıyı kopyala

Konuşma mesajları (yeniden eskiye; giden mesaj durumu teslimattan)Bağlantıyı kopyala

200 — Başarılı.Bağlantıyı kopyala

Yanıt gönder. WhatsApp: açık rıza zorunlu; son gelen mesajdan 24 saat içinde metin/medya, pencere dışında yalnızca onaylı şablon (aksi 422 WHATSAPP_WINDOW_CLOSED).Bağlantıyı kopyala

202 — Başarılı.Bağlantıyı kopyala

Gelen mesajları okundu işaretleBağlantıyı kopyala

200 — Başarılı.Bağlantıyı kopyala

İki yönlü mesaj anahtar sözcükleri (org geneli + bu app) ve yasal (ayrılmış) sözcüklerBağlantıyı kopyala

200 — Başarılı.Bağlantıyı kopyala

Anahtar sözcük oluştur (tag ekle/kaldır, olay → journey tetiği, otomatik yanıt, abonelik)Bağlantıyı kopyala

201 — Başarılı.Bağlantıyı kopyala

Anahtar sözcüğü güncelleBağlantıyı kopyala

200 — Başarılı.Bağlantıyı kopyala

Anahtar sözcüğü silBağlantıyı kopyala

200 — Başarılı.Bağlantıyı kopyala

WhatsApp şablonları (Meta onay durumu ile)Bağlantıyı kopyala

200 — Başarılı.Bağlantıyı kopyala

WhatsApp şablonlarını Meta Graph API’den senkronlaBağlantıyı kopyala

200 — Başarılı.Bağlantıyı kopyala

Bu sayfada

İşlemler

Ayrıntılar

Konuşmalar (SMS, WhatsApp, RCS; son mesaja göre; kanal/durum/okunmamış/kişi filtresi)

200 — Başarılı.

Konuşma (WhatsApp oturum penceresi ve açık rıza durumu dahil)

200 — Başarılı.

Konuşma mesajları (yeniden eskiye; giden mesaj durumu teslimattan)

200 — Başarılı.

Yanıt gönder. WhatsApp: açık rıza zorunlu; son gelen mesajdan 24 saat içinde metin/medya, pencere dışında yalnızca onaylı şablon (aksi 422 WHATSAPP_WINDOW_CLOSED).

202 — Başarılı.

Gelen mesajları okundu işaretle

200 — Başarılı.

İki yönlü mesaj anahtar sözcükleri (org geneli + bu app) ve yasal (ayrılmış) sözcükler

200 — Başarılı.

Anahtar sözcük oluştur (tag ekle/kaldır, olay → journey tetiği, otomatik yanıt, abonelik)

201 — Başarılı.

Anahtar sözcüğü güncelle

200 — Başarılı.

Anahtar sözcüğü sil

200 — Başarılı.

WhatsApp şablonları (Meta onay durumu ile)

200 — Başarılı.

WhatsApp şablonlarını Meta Graph API’den senkronla

200 — Başarılı.