# व्हाट्सएप एपीआई

import { Badge } from '@astrojs/starlight/components';

<Aside type="caution" title="/createWhatsAppMessage अब पदावनत है">
नए इंटीग्रेशन को [Messaging API v2](/hi/developer/api-reference/messaging-api-v2/) का उपयोग करना चाहिए — `Notify` में `platforms: ["WHATS_APP"]` पास करें और `payload.content.localized_content` के अंदर `whatsapp` ब्लॉक का उपयोग करें। [माइग्रेशन गाइड](/hi/developer/api-reference/messaging-api-v2/migration-from-v1/#from-createwhatsappmessage) देखें।
</Aside>

<Aside type="note">
व्हाट्सएप संदेश भेजने से पहले, सुनिश्चित करें कि व्हाट्सएप प्लेटफॉर्म ठीक से कॉन्फ़िगर किया गया है। [और जानें](/hi/product/first-steps/start-with-your-project/configure-platforms/whatsapp-configuration/)
</Aside>

## createWhatsAppMessage <Badge text="पदावनत" variant="caution" size="small" />

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

`POST` `https://api.pushwoosh.com/json/1.3/createWhatsAppMessage`

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

| नाम  <div style="width:180px"></div>   | आवश्यक <div style="width:100px"></div> | प्रकार | विवरण |
| :---- | :---- | :---- | :---- |
| auth\* | हाँ | string | Pushwoosh कंट्रोल पैनल से [API एक्सेस टोकन](/hi/developer/api-reference/api-identifiers/#api-access-token)। |
| application\* | हाँ | string | [Pushwoosh एप्लिकेशन कोड](/hi/developer/api-reference/api-identifiers/#application-code) |
| notifications\* | हाँ | array | कंटेंट सेटिंग्स। संदेश पैरामीटर का JSON ऐरे। नीचे विवरण देखें। |

### नोटिफिकेशन पैरामीटर्स

| नाम   <div style="width:150px"></div>     | आवश्यक                                  | प्रकार    | विवरण                                                                                                                                                                                                                                                                                  |
|:----------------------|:------------------------------------------|:--------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| send_date*            | हाँ                                       | string  | नोटिफिकेशन भेजने की तारीख और समय। तुरंत भेजने के लिए `YYYY-MM-DD HH:mm` प्रारूप या `'now'` का उपयोग करें।                                                                                                                                                                                        |
| content               | यदि `content_id` प्रदान नहीं किया गया है तो आवश्यक है। | string  | व्हाट्सएप संदेश की टेक्स्ट सामग्री।                                                                                                                                                                                                                                                        |
| content_id            | यदि `content` प्रदान नहीं किया गया है तो आवश्यक है।    | string  | आपके मेटा खाते से पूर्व-अनुमोदित व्हाट्सएप टेम्पलेट के लिए पहचानकर्ता।                                                                                                                                                                                                                      |
| devices*              | हाँ                                       | array   | ग्राहक का फ़ोन नंबर ([`/registerDevice`](/hi/developer/api-reference/device-api#registerdevice) का उपयोग करके [यूज़र आईडी](/hi/developer/api-reference/api-identifiers/#user-id) से जुड़ा होना चाहिए और `hwid` पैरामीटर में निर्दिष्ट होना चाहिए, या `use_auto_registration` का उपयोग करें)। यहां केवल एक नंबर निर्दिष्ट किया जा सकता है। |
| use_auto_registration | नहीं                                        | boolean | यदि `true` पर सेट है, तो `devices` पैरामीटर में निर्दिष्ट फ़ोन नंबर स्वचालित रूप से पंजीकृत हो जाएगा।                                                                                                                                                                                    |
| content_variables     | नहीं                                        | object  | संदेश सामग्री को अनुकूलित करने के लिए कंटेंट चर। प्रत्येक प्लेसहोल्डर को संबंधित गतिशील मानों से बदल दिया जाएगा।                                                                           |
| button_url_variables  | नहीं                                        | object     | बटनों के लिए गतिशील यूआरएल चर। प्रत्येक कुंजी एक बटन इंडेक्स का प्रतिनिधित्व करती है, और इसका मान बटन के यूआरएल में बदलने के लिए गतिशील चर है। **ध्यान दें**: बटन इंडेक्सिंग 0 से शुरू होती है, जिसमें पहला बटन 0, दूसरा 1, और इसी तरह होता है।                                                                                              |
| header_variables      | नहीं                                        | object  | व्हाट्सएप टेम्पलेट संदेश में हेडर के लिए चर। `type` (जैसे, `text`, `image`, `video`, `document`) और संबंधित मान निर्दिष्ट करें। **उदाहरण**: `"header_variables": {"image": "https://image-url.png"}`                                                                   |
| preset                | नहीं                                        | string  | आपके कंट्रोल पैनल से व्हाट्सएप प्रीसेट कोड।                                                                                |
| language              | नहीं                                        | string  | व्हाट्सएप टेम्पलेट की भाषा लोकेल (मेटा व्हाट्सएप टेम्पलेट संपादक में लोकेल से मेल खाना चाहिए)। डिफ़ॉल्ट: `"en_US"`। उदाहरण: `"en_GB"`।                                                                                                            |

<Aside type="caution" title="महत्वपूर्ण">
****
वर्तमान में, प्रत्येक ग्राहक के लिए प्रत्येक व्हाट्सएप संदेश एक अलग अनुरोध में भेजा जाना चाहिए।
</Aside>

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

```json
{
  "request": {
    "application": "12XXX-67XXX",           // आवश्यक। Pushwoosh एप्लिकेशन कोड।
    "auth": "yxoPUlwqm…………pIyEX4H",         // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
    "notifications": [{
      "send_date": "now",                   // आवश्यक। YYYY-MM-DD HH:mm या "now"।
      "content": "Hello! {{1}}",            // आवश्यक यदि content_id प्रदान नहीं किया गया है। संदेश का टेक्स्ट।
      "content_id": "hello_world",          // आवश्यक यदि content प्रदान नहीं किया गया है। व्हाट्सएप टेम्पलेट पहचानकर्ता।
      "devices": ["whatsapp:+1234567890"],  // आवश्यक। ग्राहक का व्हाट्सएप फ़ोन नंबर (जुड़ा होना चाहिए
                                            //           /registerDevice का उपयोग करके एक UserId के साथ और में निर्दिष्ट
                                            //           "hwid" पैरामीटर या "use_auto_registration" का उपयोग करें)।
                                            //           यहां केवल एक व्हाट्सएप नंबर निर्दिष्ट किया जा सकता है।
      "preset": "XXXXX-XXXXX",              // वैकल्पिक। आपके कंट्रोल पैनल से व्हाट्सएप प्रीसेट कोड।
      "content_variables": {                // वैकल्पिक। संदेश सामग्री को अनुकूलित करने के लिए कंटेंट चर।
        "1": "John"
      },
      "header_variables": {                 // वैकल्पिक। व्हाट्सएप संदेश हेडर के लिए चर।
        "image": "https://image-url.png"
      },
      "language": "en_GB",                  // वैकल्पिक। व्हाट्सएप टेम्पलेट के लिए भाषा लोकेल (मेटा व्हाट्सएप टेम्पलेट संपादक में लोकेल से मेल खाना चाहिए)। डिफ़ॉल्ट: "en_US"।
      "use_auto_registration": true         // वैकल्पिक। निर्दिष्ट व्हाट्सएप नंबर को स्वचालित रूप से पंजीकृत करें
                                            //           "devices" पैरामीटर में।
    }]
  }
}
```

### उदाहरण: व्हाट्सएप के माध्यम से दो-कारक प्रमाणीकरण कोड भेजना

```json
{
    "request": {
        "application":"APP_CODE", "auth":"AUTH_TOKEN",
        "notifications":[{
            "send_date":"now",
            "content_id":"replace_with_your_meta_two_factor_template_name",
            "content_variables":{"1":"AUTH_CODE"},
            "button_url_variables":{"0":"AUTH_CODE"},
            "devices":["whatsapp:REPLACE_WITH_YOUR_PHONE_NO"]
        }]
    }
}
```

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

```json
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "9648-0B10EXXX-0D9F2XXX"
    ]
  }
}
```

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

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