सामग्री पर जाएं

SMS API

createSMSMessage

Anchor link to

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

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

Request body

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

Notification parameters

नामआवश्यकप्रकारविवरण
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आपके Control Panel से SMS Preset Code

Request example

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

Response example

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

Error response

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

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

आप Message History अनुभाग में प्रत्येक संदेश के आंकड़े भी देख सकते हैं।