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

एसएमएस API

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",    // required. Pushwoosh application code.
    "auth": "yxoPUlwqm…………pIyEX4H",  // required. API access token from Pushwoosh Control Panel.
    "notifications": [{
      "send_date": "now",            // required. YYYY-MM-DD HH:mm OR "now".
      "content": "Hello!",           // required. SMS text (string).
      "devices": ["+1234567890"],    // required. Customer phone number (must be associated with
                                     //           a UserId using. /registerDevice and specified in
                                     //           the "hwid" parameter or use "use_auto_registration").
                                     //           Only one number can be specified here.
      "preset": "XXXXX-XXXXX",       // optional. SMS Preset Code from your Control Panel.
      "use_auto_registration": true  // optional. Automatically register phone number specified
                                     //           in "devices" parameter.
    }]
  }
}

रिस्पॉन्स का उदाहरण

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 विधि का उपयोग करें।

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