सामग्री पर जाएं
उपयोगकर्ता गाइड सहायता डेमो अनुरोध करें साइन इन करें
Pushwoosh.com

एसएमएस एपीआई

createSMSMessage पदावनत

Anchor link to

उपयोगकर्ताओं को एसएमएस सूचनाएं भेजने के लिए उपयोग किया जाता है

POST https://api.pushwoosh.com/json/1.3/createSMSMessage

अनुरोध बॉडी

Anchor link to
नामआवश्यकप्रकारविवरण
auth*हाँस्ट्रिंगPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application*हाँस्ट्रिंगPushwoosh एप्लिकेशन कोड
notifications*हाँऐरेसामग्री सेटिंग्स। संदेश मापदंडों का JSON ऐरे। नीचे विवरण देखें।

अधिसूचना पैरामीटर

नामआवश्यकप्रकारविवरण
send_date*हाँस्ट्रिंगअधिसूचना भेजने की तारीख और समय। तुरंत भेजने के लिए YYYY-MM-DD HH:mm या now प्रारूप का उपयोग करें।
content*हाँस्ट्रिंगएसएमएस संदेश की पाठ्य सामग्री।
devices*हाँऐरेग्राहक का फ़ोन नंबर (/registerDevice का उपयोग करके एक UserId से जुड़ा होना चाहिए और hwid पैरामीटर में निर्दिष्ट होना चाहिए या use_auto_registration का उपयोग करें)। यहाँ केवल एक नंबर निर्दिष्ट किया जा सकता है।
use_auto_registrationनहींबूलियनयदि true पर सेट किया गया है, तो devices पैरामीटर में निर्दिष्ट फ़ोन नंबर स्वचालित रूप से पंजीकृत हो जाएगा।
dynamic_content_placeholdersनहींऑब्जेक्टसंदेश सामग्री को अनुकूलित करने के लिए डायनामिक सामग्री प्लेसहोल्डर। प्रत्येक प्लेसहोल्डर को संबंधित डायनामिक मानों से बदल दिया जाएगा।
presetनहींस्ट्रिंगआपके कंट्रोल पैनल से एसएमएस प्रीसेट कोड।

अनुरोध का उदाहरण

Anchor link to
{
  "request": {
    "application": "12345-67891",    // आवश्यक। Pushwoosh एप्लिकेशन कोड।
    "auth": "yxoPUlwqm…………pIyEX4H",  // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
    "notifications": [{
      "send_date": "now",            // आवश्यक। YYYY-MM-DD HH:mm या "now"।
      "content": "Hello!",           // आवश्यक। एसएमएस पाठ (स्ट्रिंग)।
      "devices": ["+1234567890"],    // आवश्यक। ग्राहक का फ़ोन नंबर (`/registerDevice` का उपयोग करके
                                     //           एक UserId से जुड़ा होना चाहिए और "hwid" पैरामीटर में
                                     //           निर्दिष्ट होना चाहिए या "use_auto_registration" का उपयोग करें)।
                                     //           यहाँ केवल एक नंबर निर्दिष्ट किया जा सकता है।
      "preset": "XXXXX-XXXXX",       // वैकल्पिक। आपके कंट्रोल पैनल से एसएमएस प्रीसेट कोड।
      "use_auto_registration": true  // वैकल्पिक। "devices" पैरामीटर में निर्दिष्ट फ़ोन नंबर को
                                     //           स्वचालित रूप से पंजीकृत करें।
    }]
  }
}

प्रतिक्रिया का उदाहरण

Anchor link to
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "9648-0B10ECB6-0D9F214D"
    ]
  }
}

त्रुटि प्रतिक्रिया

Anchor link to
{
  "status_code": 210,
  "status_message": "Invalid devices list. \"devices\" must be an array.",
  "response": {
    "Messages": []
  }
}

एसएमएस आँकड़े प्राप्त करने के लिए, totalsByIntervals विधि का उपयोग करें।

आप संदेश इतिहास अनुभाग में प्रत्येक संदेश के लिए आँकड़े भी देख सकते हैं।