LINE API

नोट

LINE संदेश भेजने से पहले, सुनिश्चित करें कि Line प्लेटफ़ॉर्म ठीक से कॉन्फ़िगर किया गया है। और जानें

createLineMessage

उपयोगकर्ताओं को LINE संदेश भेजने के लिए उपयोग किया जाता है

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

एक टेक्स्ट संदेश भेजें

सरल LINE संदेश जिनमें केवल सादा टेक्स्ट होता है, बिना इमेज या बटन के। और जानें

सुझाव: उन्नत फ़ॉर्मेटिंग और रिच मीडिया के लिए, फ्लेक्स, इमेज, या कैरोसेल जैसे संदेश टेम्प्लेट का उपयोग करें।

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

पैरामीटर	प्रकार	आवश्यक	विवरण
application	string	हाँ	Pushwoosh एप्लिकेशन कोड
auth	string	हाँ	रिक्वेस्ट को प्रमाणित करने के लिए API एक्सेस टोकन।
notifications	array of objects	हाँ	भेजे जाने वाले LINE संदेश ऑब्जेक्ट्स की सूची।
content	string	हाँ	भेजे जाने वाले LINE संदेश का टेक्स्ट। अधिकतम कैरेक्टर सीमा: 5000। ध्यान दें: यदि preset और content दोनों शामिल हैं, तो रिक्वेस्ट से प्राप्त मान preset को ओवरराइड कर देगा।
preset	string	नहीं	Pushwoosh कंट्रोल पैनल में आपके द्वारा बनाए गए LINE प्रीसेट का कोड। ध्यान दें: यदि preset और content दोनों शामिल हैं, तो रिक्वेस्ट से प्राप्त मान preset को ओवरराइड कर देगा।
send_date	string	हाँ	संदेश भेजने की तारीख और समय। तुरंत भेजने के लिए YYYY-MM-DD HH:mm या now प्रारूप का उपयोग करें।
devices	array of strings	हाँ	डिवाइस कोड (यूज़र आईडी) की सूची जिन्हें LINE संदेश भेजना है।

{
    "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
        "notifications": [
            {
                "content": "test",
                "preset": "preset_code",
                "send_date":"now",
                "devices": ["XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"]
            }
        ]
    }
}

एक इमेज संदेश भेजें

आप अपने रिक्वेस्ट के टेम्प्लेट फ़ील्ड के भीतर एक इमेज ऑब्जेक्ट निर्दिष्ट करके LINE उपयोगकर्ताओं को एक इमेज संदेश भेज सकते हैं।

प्रत्येक इमेज संदेश के लिए दो इमेज URL की आवश्यकता होती है: एक पूर्ण-आकार की इमेज (image_url) के लिए और दूसरा प्रीव्यू (preview_image_url) के लिए। जब उपयोगकर्ता प्रीव्यू पर टैप करते हैं, तो पूर्ण-आकार की इमेज खुल जाती है। सुनिश्चित करें कि दोनों URL HTTPS (TLS 1.2 या बाद का) का उपयोग करते हैं और सार्वजनिक रूप से सुलभ इमेज फ़ाइलों से लिंक होते हैं।

विवरण के लिए, LINE मैसेजिंग API दस्तावेज़ में इमेज संदेश अनुभाग देखें।

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

पैरामीटर	प्रकार	आवश्यक	विवरण
application	string	हाँ	Pushwoosh एप्लिकेशन कोड
auth	string	हाँ	रिक्वेस्ट को प्रमाणित करने के लिए उपयोग किया जाने वाला API एक्सेस टोकन।
notifications	array of objects	हाँ	भेजे जाने वाले संदेशों की सूची।
content	string	हाँ	संदेश के लिए फॉलबैक या प्रीव्यू टेक्स्ट के रूप में उपयोग किया जाता है। Pushwoosh कंट्रोल पैनल में आपके द्वारा बनाए गए LINE प्रीसेट का कोड। ध्यान दें: यदि preset और template दोनों शामिल हैं, तो रिक्वेस्ट से template का उपयोग किया जाता है। यदि preset और content दोनों शामिल हैं, तो रिक्वेस्ट से content प्रीसेट को ओवरराइड कर देगा।
send_date	string	हाँ	संदेश भेजने की तारीख और समय। तुरंत भेजने के लिए YYYY-MM-DD HH:mm या now प्रारूप का उपयोग करें।
devices	array of strings	हाँ	डिवाइस कोड (यूज़र आईडी) की सूची जिन्हें LINE संदेश भेजना है।
preset	string	नहीं	Pushwoosh कंट्रोल पैनल में आपके द्वारा बनाए गए LINE प्रीसेट का कोड। ध्यान दें: यदि रिक्वेस्ट में preset और template दोनों पैरामीटर शामिल हैं, तो template के मान प्रीसेट में परिभाषित मानों को ओवरराइड कर देंगे। यदि एक ही रिक्वेस्ट में preset और content दोनों शामिल हैं, तो सीधे रिक्वेस्ट में प्रदान किया गया content, preset से सामग्री को ओवरराइड कर देगा।
template	object	हाँ	संदेश लेआउट टेम्प्लेट। कई संदेश प्रकारों का समर्थन करता है। नीचे विवरण देखें।

टेम्प्लेट पैरामीटर

प्रकार: image

पैरामीटर	प्रकार	आवश्यक	विवरण
image_url	string	हाँ	पूर्ण-आकार की इमेज का URL (HTTPS का उपयोग करना चाहिए)। अधिकतम लंबाई: 2000 कैरेक्टर। प्रारूप: JPEG, PNG। अधिकतम आकार: 10 MB।
preview_image_url	string	हाँ	चैट में दिखाए गए प्रीव्यू इमेज का URL (HTTPS का उपयोग करना चाहिए)। अधिकतम लंबाई: 2000 कैरेक्टर। प्रारूप: JPEG, PNG। अधिकतम आकार: 1 MB।

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

{
  "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
    "notifications": [
      {
        "content": "test",
        "send_date": "now",
        "devices": [
          "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        ],
        "preset": "preset_code",
        "template": {
          "en": {
            "image": {
              "alt_text": "some text",
              "image_url": "https://images.com/1.jpg",
              "preview_image_url": "https://images.com/1.png"
            }
          }
        }
      }
    ]
  }
}

एक इमेज कैरोसेल संदेश भेजें

इमेज कैरोसेल संदेश आपको क्षैतिज रूप से स्क्रॉल करने योग्य प्रारूप में कई इमेज प्रदर्शित करने की सुविधा देते हैं। प्रत्येक इमेज एक अलग, गैर-क्लिक करने योग्य कॉलम के रूप में दिखाई देती है जिसे उपयोगकर्ता LINE चैट इंटरफ़ेस में स्वाइप कर सकते हैं।

यह प्रारूप आकर्षक तरीके से आइटम, प्रचार, या विज़ुअल चयन दिखाने के लिए आदर्श है।

विवरण के लिए, LINE मैसेजिंग API दस्तावेज़ में इमेज कैरोसेल टेम्प्लेट अनुभाग देखें।

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

पैरामीटर	प्रकार	आवश्यक	विवरण
application	string	हाँ	Pushwoosh एप्लिकेशन कोड
auth	string	हाँ	रिक्वेस्ट को प्रमाणित करने के लिए उपयोग किया जाने वाला API एक्सेस टोकन।
notifications	array of objects	हाँ	भेजे जाने वाले संदेशों की सूची।
content	string	हाँ	संदेश के लिए फॉलबैक या प्रीव्यू टेक्स्ट के रूप में उपयोग किया जाता है। ध्यान दें: यदि content और template दोनों सेट हैं, तो template का उपयोग किया जाता है। यदि एक ही रिक्वेस्ट में preset और content दोनों शामिल हैं, तो सीधे रिक्वेस्ट में प्रदान किया गया content, preset से सामग्री को ओवरराइड कर देगा।
send_date	string	हाँ	संदेश भेजने की तारीख और समय। YYYY-MM-DD HH:mm या "now" प्रारूप का उपयोग करें।
devices	array of strings	हाँ	डिवाइस कोड (यूज़र आईडी) की सूची जिन्हें LINE संदेश भेजना है।
preset	string	नहीं	Pushwoosh कंट्रोल पैनल में आपके द्वारा बनाए गए LINE प्रीसेट का कोड। ध्यान दें: यदि रिक्वेस्ट में preset और template दोनों पैरामीटर शामिल हैं, तो template के मान preset में परिभाषित मानों को ओवरराइड कर देंगे। यदि एक ही रिक्वेस्ट में preset और content दोनों शामिल हैं, तो सीधे रिक्वेस्ट में प्रदान किया गया content, preset से सामग्री को ओवरराइड कर देगा।
template	object	हाँ	संदेश लेआउट टेम्प्लेट। कई संदेश प्रकारों का समर्थन करता है। नीचे विवरण देखें।

टेम्प्लेट पैरामीटर

प्रकार: image_carousel

पैरामीटर	प्रकार	आवश्यक	विवरण
alt_text	string	हाँ	पुश प्रीव्यू और असमर्थित डिवाइस पर प्रदर्शित होने वाला फॉलबैक टेक्स्ट। अधिकतम 400 कैरेक्टर।
columns	array of objects	हाँ	इमेज कॉलम की ऐरे (1-10 समर्थित)। प्रत्येक कॉलम में एक इमेज शामिल है।
image_url	string	हाँ	प्रत्येक कैरोसेल कॉलम में दिखाई गई इमेज का URL जो सार्वजनिक रूप से सुलभ JPEG या PNG फ़ाइल को इंगित करता है। HTTPS का उपयोग करना चाहिए।

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

{
  "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
    "notifications": [
      {
        "content": "test",
        "send_date": "now",
        "devices": [
          "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        ],
        "preset": "preset_code",
        "template": {
          "en": {
            "image_carousel": {
              "alt_text": "some text",
              "columns": [
                { "image_url": "https://images.com/1.jpg" },
                { "image_url": "https://images.com/2.jpg" },
                { "image_url": "https://images.com/3.jpg" }
              ]
            }
          }
        }
      }
    ]
  }
}

एक फ्लेक्स संदेश भेजें

फ्लेक्स संदेश शक्तिशाली, अनुकूलन योग्य संदेश प्रकार हैं जो आपको टेक्स्ट, इमेज, बटन और अन्य घटकों का उपयोग करके संरचित लेआउट बनाने की अनुमति देते हैं। वे रसीदें, उत्पाद कार्ड, मेनू, या किसी भी सामग्री जैसे उपयोग के मामलों के लिए आदर्श हैं जिन्हें विज़ुअल संरचना से लाभ होता है।

फ्लेक्स संदेश भेजने के लिए, अपने रिक्वेस्ट के अंदर raw पेलोड के साथ एक template ऑब्जेक्ट शामिल करें। संदेश लेआउट को LINE फ्लेक्स संदेश विनिर्देश का पालन करना चाहिए।

सुझाव: आप LINE फ्लेक्स संदेश सिम्युलेटर का उपयोग करके फ्लेक्स संदेशों को डिज़ाइन और प्रीव्यू कर सकते हैं।

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

पैरामीटर	प्रकार	आवश्यक	विवरण
application	string	हाँ	Pushwoosh एप्लिकेशन कोड
auth	string	हाँ	रिक्वेस्ट को प्रमाणित करने के लिए उपयोग किया जाने वाला API एक्सेस टोकन।
notifications	array of objects	हाँ	भेजे जाने वाले संदेशों की सूची।
content	string	हाँ	संदेश के लिए फॉलबैक या प्रीव्यू टेक्स्ट के रूप में उपयोग किया जाता है। ध्यान दें: यदि content और template दोनों सेट हैं, तो टेम्प्लेट का उपयोग किया जाता है। यदि preset और content दोनों शामिल हैं, तो रिक्वेस्ट से सामग्री प्रीसेट को ओवरराइड कर देगी।
send_date	string	हाँ	संदेश कब भेजना है। "now" या YYYY-MM-DD HH:mm प्रारूप का उपयोग करें।
devices	array of strings	हाँ	संदेश प्राप्त करने के लिए LINE डिवाइस टोकन (यूज़र आईडी) की सूची।
preset	string	नहीं	Pushwoosh कंट्रोल पैनल में आपके द्वारा बनाए गए LINE प्रीसेट का कोड। ध्यान दें: यदि preset और template दोनों शामिल हैं, तो टेम्प्लेट प्रीसेट को ओवरराइड करता है। यदि preset और content दोनों शामिल हैं, तो रिक्वेस्ट से सामग्री प्रीसेट को ओवरराइड कर देगी।
template	object	हाँ	संदेश लेआउट टेम्प्लेट। कई संदेश प्रकारों का समर्थन करता है। नीचे विवरण देखें।

टेम्प्लेट पैरामीटर

फ्लेक्स संदेश के लिए, रॉ संरचना का उपयोग करें।
प्रकार: raw (फ्लेक्स)

पैरामीटर	प्रकार	आवश्यक	विवरण
alt_text	string	हाँ	सूचनाओं, चैट प्रीव्यू और कोट्स में दिखाया गया फॉलबैक टेक्स्ट। अधिकतम 400 कैरेक्टर।
content	object	हाँ	फ्लेक्स संदेश लेआउट, LINE के फ्लेक्स विनिर्देश के अनुसार bubble, box, text, और अन्य घटकों का उपयोग करके संरचित।

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

{
  "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
    "notifications": [
      {
        "content": "test",
        "send_date": "now",
        "devices": ["XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"],
        "preset": "preset_code",
        "template": {
          "en": {
            "raw": {
              "alt_text": "My raw template",
              "content": {
                "type": "bubble",
                "body": {
                  "type": "box",
                  "layout": "vertical",
                  "contents": [
                    {
                      "type": "text",
                      "text": "RECEIPT",
                      "weight": "bold",
                      "color": "#1DB446",
                      "size": "sm"
                    }
                    // Additional components...
                  ]
                }
              }
            }
          }
        }
      }
    ]
  }
}