Notify बैच

POST https://api.pushwoosh.com/messaging/v2/notify/batch

एक कॉल में कई संदेश भेजता है। प्रत्येक आइटम एक स्वतंत्र Notify है: इसे ठीक एक स्टैंडअलोन Notify अनुरोध की तरह मान्य किया जाता है, और इसे अपना परिणाम मिलता है।

NotifyBatch सीधे Notify को कॉल करने की तुलना में तेजी से संदेश नहीं भेजता है। यदि आपका इंटीग्रेशन पहले से ही समवर्ती रूप से अनुरोध जारी कर सकता है, तो समानांतर थ्रेड्स/वर्कर्स में Notify चलाने से समान थ्रूपुट मिलता है — HTTP/2 इसे डिज़ाइन द्वारा संभालता है। NotifyBatch का उपयोग सुविधा के लिए करें जब आपका इंटीग्रेशन समवर्तीता के लिए नहीं बनाया गया हो, गति के लिए नहीं।

अनुरोध संरचना

{
  "items": [
    {
      "item_id": "caller-defined-id",
      "request": { ... }
    }
  ]
}

फील्ड	प्रकार	विवरण
`items`	`NotifyBatchItem` का ऐरे	आवश्यक, 1 से 500 प्रविष्टियाँ (सर्वर-कॉन्फ़िगर की गई सीमा)। आइटम समवर्ती रूप से संसाधित होते हैं; परिणाम अनुरोध क्रम में वापस आते हैं, भले ही कुछ भी हो।

NotifyBatchItem

फील्ड	प्रकार	विवरण
`item_id`	स्ट्रिंग	वैकल्पिक कॉलर-आपूर्ति सहसंबंध आईडी, मिलान परिणाम पर वापस प्रतिध्वनित होती है। अन्यथा Pushwoosh द्वारा उपयोग नहीं किया जाता है।
`request`	`NotifyRequest`	एकल `Notify` कॉल के समान बॉडी — `segment` या `transactional`, `transaction_id` शामिल है। आवश्यक।

प्रत्येक आइटम के request पर transaction_id सेट करें। समान transaction_id के साथ एक दोहराई गई कॉल Notify पृष्ठ पर वर्णित 5-मिनट की डिडुप्लीकेशन विंडो के भीतर उस आइटम के लिए समान message_code लौटाती है — इसलिए नेटवर्क त्रुटि के बाद पूरे बैच को पुनः प्रयास करने से वे संदेश डुप्लिकेट नहीं होते हैं जो पहले ही भेजे जा चुके हैं।

उदाहरण

curl -X POST https://api.pushwoosh.com/messaging/v2/notify/batch \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "item_id": "order-1001",
        "request": {
          "transactional": {
            "application": "XXXXX-XXXXX",
            "platforms": ["IOS", "ANDROID"],
            "users": { "list": ["user-123"] },
            "payload": {
              "content": {
                "localized_content": {
                  "en": { "ios": { "body": "Your order has shipped." } }
                }
              }
            },
            "schedule": { "at": "2026-05-01T12:00:00Z" },
            "message_type": "MESSAGE_TYPE_TRANSACTIONAL",
            "transaction_id": "order-1001-shipped"
          }
        }
      },
      {
        "item_id": "order-1002",
        "request": {
          "transactional": {
            "application": "XXXXX-XXXXX",
            "platforms": ["IOS", "ANDROID"],
            "users": { "list": ["user-456"] },
            "payload": {
              "content": {
                "localized_content": {
                  "en": { "ios": { "body": "Your order has shipped." } }
                }
              }
            },
            "schedule": { "at": "2026-05-01T12:00:00Z" },
            "message_type": "MESSAGE_TYPE_TRANSACTIONAL",
            "transaction_id": "order-1002-shipped"
          }
        }
      }
    ]
  }'

प्रतिक्रिया

{
  "results": [
    {
      "item_id": "order-1001",
      "index": 0,
      "result": {
        "message_code": "XXXXX-XXXXX-XXXXX",
        "unknown_identifiers": []
      }
    },
    {
      "item_id": "order-1002",
      "index": 1,
      "error": {
        "code": 3,
        "message": "invalid argument",
        "reason": "EmptySchedule",
        "domain": "api.pushwoosh.com"
      }
    }
  ],
  "succeeded": 1,
  "failed": 1
}

फील्ड	प्रकार	विवरण
`results`	`NotifyBatchResult` का ऐरे	अनुरोधित प्रत्येक आइटम के लिए एक प्रविष्टि, अनुरोध क्रम में।
`succeeded`	पूर्णांक	उन आइटम्स की संख्या जिन्होंने परिणाम लौटाया।
`failed`	पूर्णांक	उन आइटम्स की संख्या जिन्होंने त्रुटि लौटाई।

NotifyBatchResult

फील्ड	प्रकार	विवरण
`item_id`	स्ट्रिंग	अनुरोध आइटम के `item_id` की प्रतिध्वनि।
`index`	पूर्णांक	अनुरोध में आइटम की शून्य-आधारित स्थिति। जब `item_id` खाली छोड़ दिया गया हो तो परिणामों को सहसंबंधित करने के लिए इसका उपयोग करें।
`result`	ऑब्जेक्ट	जब आइटम सफल होता है तो सेट करें — एकल `Notify` प्रतिक्रिया के समान आकार: `message_code` और `unknown_identifiers`।
`error`	`NotifyBatchError`	जब आइटम विफल हो जाता है तो सेट करें।

NotifyBatchError

फील्ड	प्रकार	विवरण
`code`	पूर्णांक	gRPC स्टेटस कोड (`google.rpc.Code`), जैसे `INVALID_ARGUMENT` के लिए `3`।
`message`	स्ट्रिंग	डेवलपर-फेसिंग त्रुटि संदेश, अंग्रेजी में।
`reason`	स्ट्रिंग	संक्षिप्त स्थिति नाम — वही मान जो एक एकल `Notify` कॉल लौटाएगा, जैसे `EmptySchedule`।
`domain`	स्ट्रिंग	त्रुटि डोमेन, `api.pushwoosh.com`।

त्रुटियाँ

त्रुटियाँ मानक gRPC-गेटवे त्रुटि एनवेलप का उपयोग करती हैं: { "code": ..., "message": ..., "details": [...] }। ये एनवेलप-स्तरीय त्रुटियाँ हैं जो पूरे अनुरोध को विफल करती हैं — एक व्यक्तिगत आइटम का विफल होना इसके बजाय results[] में प्रति-आइटम error उत्पन्न करता है (ऊपर NotifyBatchError देखें), इनमें से कोई एक नहीं।

HTTP स्थिति	शर्त
`400`	`items` खाली है।
`400`	`items` में सर्वर-कॉन्फ़िगर की गई सीमा (डिफ़ॉल्ट रूप से 500) से अधिक है।
`400`	आइटम में से एक में `request` गायब है।

उदाहरण

जब सीमा 500 हो तो 501 आइटम भेजने पर HTTP 400 लौटता है:

{
  "code": 3,
  "message": "items must not exceed 500 entries, got 501",
  "details": []
}