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

SMS API

createSMSMessage पदावनत

Anchor link to

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

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

रिक्वेस्ट बॉडी

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

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

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

रिक्वेस्ट का उदाहरण

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!",           // आवश्यक। SMS टेक्स्ट (स्ट्रिंग)।
      "devices": ["+1234567890"],    // आवश्यक। ग्राहक का फ़ोन नंबर (/registerDevice का उपयोग करके
                                     //           UserId से जुड़ा होना चाहिए और "hwid" पैरामीटर में
                                     //           निर्दिष्ट होना चाहिए या "use_auto_registration" का उपयोग करना चाहिए)।
                                     //           यहाँ केवल एक नंबर निर्दिष्ट किया जा सकता है।
      "preset": "XXXXX-XXXXX",       // वैकल्पिक। आपके कंट्रोल पैनल से SMS प्रीसेट कोड।
      "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": []
  }
}

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

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