WhatsApp संदेश भेजना

एक न्यूनतम सेंड

const msg = await bird.whatsapp.send({
  to: "+15551234567",
  template: {
    slug: "bird_otp",
    components: [{ type: "body", parameters: [{ type: "text", text: "123456" }] }],
  },
});
console.log(msg.id, msg.status);

msg = client.whatsapp.send(
    to="+31612345678",
    template="bird_otp",
    language="en",
    components=[{"type": "body", "parameters": [{"type": "text", "text": "123456"}]}],
)
print(msg.id, msg.status)

code := "123456"
msg, err := client.Whatsapp.Send(context.Background(), bird.WhatsappSendParams{
	To:       "+15551234567",
	Template: "bird_otp",
	Language: "en",
	Components: []bird.WhatsAppMessageTemplateComponent{{
		Type:       "body",
		Parameters: &[]bird.WhatsAppMessageTemplateComponentParameter{{Type: "text", Text: &code}},
	}},
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(msg.Id, *msg.Status)

$message = $bird->whatsapp->send(
    to: '+15551234567',
    template: 'bird_otp',
    language: 'en',
    components: [
        (new WhatsAppMessageTemplateComponent())
            ->setType('body')
            ->setParameters([
                (new WhatsAppMessageTemplateComponentParameter())->setType('text')->setText('123456'),
            ]),
    ],
);
echo $message->getId(), ' ', $message->getStatus();

bird whatsapp send \
  --components '[{"parameters":[{"text":"1234","type":"text"}],"type":"body"},{"parameters":[{"text":"1234","type":"text"}],"type":"button"}]' \
  --language en \
  --template bird_otp \
  --to +31612345678

curl -X POST "https://{region}.platform.bird.com/v1/whatsapp/messages" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+31612345678",
    "template": {
      "slug": "bird_otp",
      "language": "en",
      "components": [
        {
          "type": "body",
          "parameters": [
            {
              "type": "text",
              "text": "1234"
            }
          ]
        },
        {
          "type": "button",
          "parameters": [
            {
              "type": "text",
              "text": "1234"
            }
          ]
        }
      ]
    }
  }'

कस्टमर सर्विस विंडो

पेलोड बनाना

प्राप्तकर्ता

टेम्पलेट

• slug (आवश्यक): टेम्पलेट का slug, जैसे bird_order_confirmation। यह आपके कैटलॉग में किसी टेम्पलेट से मेल खाना चाहिए (लोअरकेस अक्षर, अंक, और अंडरस्कोर)।
• language: टेम्पलेट का भाषा टैग, जैसे en या pt-BR। टेम्पलेट की डिफ़ॉल्ट भाषा भेजने के लिए इसे छोड़ दें; ऐसी भाषा का नाम देना जो टेम्पलेट में नहीं है, 422 लौटाता है जो उपलब्ध भाषाएँ सूचीबद्ध करता है। स्वीकृत संदेश resolved भाषा को echo करता है।
• components: वे मान जो टेम्पलेट के वेरिएबल भरते हैं (कंपोनेंट और पैरामीटर देखें)। बिना वेरिएबल वाले टेम्पलेट के लिए इसे छोड़ दें।

कंपोनेंट और पैरामीटर

{
  "components": [
    { "type": "body", "parameters": [{ "type": "text", "text": "481920" }] },
    { "type": "button", "parameters": [{ "type": "text", "text": "481920" }] }
  ]
}

कैटेगरी और सेंडर

• एक Bird-मैनेज्ड टेम्पलेट (जिसका slug bird_ से शुरू होता है) उस नंबर से भेजता है जो Bird उस कैटेगरी के लिए रखता है, इसलिए from छोड़ दें। इसे सेट करने पर 422 WhatsAppSenderNotAllowed लौटता है।
• बाकी सब कुछ अपना सेंडर from में नाम करता है: किसी भी प्रकार का सर्विस संदेश, और आपके वर्कस्पेस द्वारा बनाया गया कोई भी टेम्पलेट। नंबर आपके वर्कस्पेस का अपना होना चाहिए। इसे छोड़ने पर 422 WhatsAppSenderRequired लौटता है, और जिस नंबर से वर्कस्पेस भेज नहीं सकता वह 422 WhatsAppSenderNotFound लौटाता है। बनाए गए टेम्पलेट को नंबर के समान WhatsApp Business Account पर भी होना चाहिए, अन्यथा सेंड 422 WhatsAppSenderWABAMismatch लौटाता है।

सर्विस संदेश

• text: { "body": "..." }, अधिकतम 4,096 अक्षर। body में पहले URL के लिए लिंक प्रीव्यू रेंडर करने हेतु "preview_url": true जोड़ें।
• image, video, audio, sticker, document: प्रत्येक एक पब्लिक https URL लेता है जिसे WhatsApp भेजते समय फ़ेच करता है (url), इसलिए साइन्ड URL को सेंड से ज़्यादा समय तक वैध रहना चाहिए। http URL सीधे अस्वीकार कर दिया जाता है। WhatsApp फ़ाइल को स्वयं फ़ेच करता है, इसलिए जो URL पहुँच में नहीं है, असमर्थित प्रकार परोसता है, या अपने प्रकार की साइज़ सीमा से बड़ी फ़ाइल है, वह स्वीकार होता है और फिर फ़ेल होता है, संदेश के last_error पर media_rejected के साथ और description में WhatsApp का अपना कारण। image, video, और document एक वैकल्पिक caption भी लेते हैं; document एक वैकल्पिक filename भी लेता है; audio वॉइस-नोट रेंडरिंग के लिए एक वैकल्पिक voice फ़्लैग लेता है।
• location: { "latitude": ..., "longitude": ... } (दोनों आवश्यक, दशमलव डिग्री) और वैकल्पिक name तथा address।
• contact_cards: एक संदेश में शेयर किए गए अधिकतम पाँच कॉन्टैक्ट का ऐरे। हर कार्ड के name को formatted_name और कम से कम एक अन्य भाग (first_name, last_name, middle_name, prefix, या suffix) चाहिए; phone_numbers, emails, urls, और addresses प्रत्येक अधिकतम दस प्रविष्टियाँ लेते हैं, और org तथा birthday (YYYY-MM-DD के रूप में) वैकल्पिक हैं। E.164 में phone_number होने पर उस कार्ड को एक बटन मिलता है जो उसके साथ चैट खोलता है।
• interactive: बॉडी टेक्स्ट और कुछ टैप करने योग्य, छह प्रकारों में से एक में: रिप्लाई बटन, लिस्ट मेनू, लिंक बटन, मीडिया कैरोसेल, या एक सिंगल बटन जो प्राप्तकर्ता से उनकी लोकेशन या फ़ोन नंबर माँगता है। इंटरैक्टिव संदेश हर प्रकार की वायर शेप, टैप से उत्पन्न रिप्लाई, और सीमाओं को कवर करता है।

{
  "to": "+16505551234",
  "from": "+13124495648",
  "text": { "body": "Your order shipped: https://example.com/track/A1B2C3", "preview_url": true }
}

संदेश को क्वोट करना

{
  "to": "+16505551234",
  "from": "+13124495648",
  "in_reply_to_message_id": "wam_01kya19eknftrs2s6p82asmvnh",
  "text": { "body": "Yes, that slot is still free." }
}

टैग और मेटाडेटा

• tags: कम-कार्डिनैलिटी डाइमेंशन (कोई कैंपेन, कोई एक्सपेरिमेंट वेरिएंट) के लिए अधिकतम 20 स्ट्रक्चर्ड { "name": ..., "value": ... } लेबल जिन पर आप फ़िल्टर और रिपोर्ट करते हैं। नाम और मान ASCII अक्षर, अंक, अंडरस्कोर, और हाइफ़न लेते हैं; नाम अधिकतम 32 अक्षर और एक सेंड में अद्वितीय, मान अधिकतम 64। टैग से संदेश सूची फ़िल्टर करें (?tag=campaign या ?tag=campaign:launch-week), और Metrics पेज टैग के अनुसार डिलीवरी विभाजित करता है।
• metadata: एक मनमाना JSON ऑब्जेक्ट, अधिकतम 2 KB सीरियलाइज़्ड, प्रति-सेंड कॉन्टेक्स्ट के लिए जो आपको फ़िल्टर डाइमेंशन के रूप में नहीं चाहिए (कोई इंटर्नल ऑर्डर ID, कोई सेशन संदर्भ)।

{
  "tags": [{ "name": "campaign", "value": "order-confirmations" }],
  "metadata": { "order_id": "ord_8271" }
}

फ़ील्ड संदर्भ

Async मॉडल: 202 का मतलब

सुरक्षित रूप से फिर से प्रयास करना

रिप्लाई प्राप्त करना

लागत और बिलिंग

• 202 पर, cost null है। कुछ भी मूल्यांकित नहीं हुआ है।
• प्रोसेसिंग के बाद, transaction_amount सेट है और amount उसके बराबर है। passthrough_amount null रहता है।
• एक लागू delivered या read रसीद के बाद, सफलतापूर्वक रिकॉर्ड किया गया Meta चार्ज passthrough_amount को भरता है, और amount रिकॉर्ड किए गए कंपोनेंट दर्शाता है।

अगले कदम

• सर्विस संदेश: नौ फ्री-फ़ॉर्म कंटेंट आर्म और हर एक क्या लेता है
• WhatsApp संदेश प्राप्त करना: इनबाउंड संदेश, मीडिया, और whatsapp.received वेबहुक
• Business-scoped user IDs: ऐसे संपर्ककर्ता को संबोधित करना जो बिना फ़ोन नंबर के आप तक पहुँचा
• Templates: कैटलॉग ब्राउज़ करें और टेम्पलेट के वेरिएबल पढ़ें
• Idempotency: Idempotency-Key हेडर के साथ सुरक्षित फिर से प्रयास