शुरुआत

Wbiztool API के साथ शुरुआत करें

Wbiztool REST API की मदद से आपका सॉफ्टवेयर आपके अपने कनेक्टेड WhatsApp नंबर से WhatsApp संदेश भेज सकता है। इसका इस्तेमाल अपने ऐप, CRM, वेबसाइट या ऑटोमेशन टूल से ऑर्डर अपडेट, रिमाइंडर और अलर्ट भेजने के लिए करें।

यह पेज बताता है कि हर रिक्वेस्ट में क्या ज़रूरी है। अपना पहला संदेश भेजने के लिए सीधे संदेश भेजें पर जाएं।

बेस URL#

सभी एंडपॉइंट इस URL के अंतर्गत हैं:

https://wbiztool.com/api/v1/

ज़्यादातर एंडपॉइंट POST रिक्वेस्ट स्वीकार करते हैं। आप बॉडी को JSON (application/json) या फॉर्म फील्ड (application/x-www-form-urlencoded) के रूप में भेज सकते हैं। फाइल अपलोड करने के लिए multipart/form-data का इस्तेमाल करें। कुछ पढ़ने वाले एंडपॉइंट GET इस्तेमाल करते हैं; हर एंडपॉइंट के पेज पर उसका मेथड लिखा है।

शुरू करने से पहले#

wbiztool.com/signup पर अकाउंट बनाएं। नए अकाउंट में 50 मुफ्त संदेश शामिल हैं।
WhatsApp नंबर कनेक्ट करें। WhatsApp सेटिंग्स खोलें, कनेक्ट पर क्लिक करें और अपने फोन के WhatsApp से QR कोड स्कैन करें।
API की बनाएं। सेटिंग्स → API Keys पर जाएं। केवल वर्कस्पेस का मालिक (owner) ही की बना सकता है। हर वर्कस्पेस में ज़्यादा से ज़्यादा 10 की हो सकती हैं।

ऑथेंटिकेशन#

ज़्यादातर एंडपॉइंट हर रिक्वेस्ट की बॉडी में आपके क्रेडेंशियल लेते हैं। नंबर वेरिफिकेशन API इसकी जगह Authorization: Bearer हेडर इस्तेमाल करता है; उसके पेज पर तरीका बताया गया है।

client_idintegerआवश्यक: आपका API क्लाइंट ID, जो सेटिंग्स → API Keys पर दिखता है।
api_keystringआवश्यक: उसी पेज से आपकी कोई एक API की। इसे गोपनीय रखें: जिसके पास भी यह की है, वह आपके नंबरों से संदेश भेज सकता है।
whatsapp_clientintegerज़्यादातर मैसेजिंग एंडपॉइंट: उस WhatsApp नंबर का ID जिससे संदेश भेजना है। यह WhatsApp सेटिंग्स पर WhatsApp क्लाइंट ID कॉलम में दिखता है। हर एंडपॉइंट के पेज पर बताया गया है कि उसे इसकी ज़रूरत है या नहीं।

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

अगर कोई की लीक हो जाए, तो उसे API Keys पेज पर डिलीट कर दें। डिलीट की गई की तुरंत काम करना बंद कर देती है।

आपकी पहली रिक्वेस्ट#

यह आपके कनेक्टेड नंबर से एक टेक्स्ट संदेश भेजता है। IDs, की और फोन नंबर की जगह अपनी वैल्यू डालें।

curl -X POST https://wbiztool.com/api/v1/send_msg/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678,
    "msg_type": 0,
    "country_code": "91",
    "phone": "9876543210",
    "msg": "Hi Aman, your order #4821 has shipped and will arrive on Thursday."
  }'

msg_id के साथ "status": 1 रिस्पॉन्स का मतलब है कि संदेश कतार में जुड़ गया है। संदेश भेजें हर पैरामीटर समझाता है और उसमें Python, Node.js और PHP वर्ज़न भी हैं।

रिस्पॉन्स और एरर#

हर रिस्पॉन्स एक JSON ऑब्जेक्ट होता है जिसमें status फील्ड होता है (सिवाय /api/v1/status/ हेल्थ चेक के, जो "status": 200 लौटाता है):

"status": 1 का मतलब है कि रिक्वेस्ट सफल रही।
"status": 0 का मतलब है कि रिक्वेस्ट फेल हो गई। message फील्ड में इसकी वजह होती है।

{ "status": 0, "message": "Auth Error: invalid api key" }

सिर्फ HTTP कोड नहीं, status फील्ड भी जांचें

एंडपॉइंट के हिसाब से, एरर HTTP 400, 403 या 200 के साथ आ सकता है। हमेशा JSON बॉडी पढ़ें और status जांचें, और पक्का करें कि रिस्पॉन्स कोड 400 या 403 होने पर भी आपका HTTP क्लाइंट बॉडी को पार्स करे। रिमाइंडर एंडपॉइंट फिलहाल अनजान API की के लिए HTTP 500 के साथ एक HTML एरर पेज लौटाते हैं। कुछ एंडपॉइंट अपने JSON रिस्पॉन्स को application/json की जगह text/html बताते हैं। Content-Type हेडर चाहे जो कहे, बॉडी को JSON के रूप में पार्स करें, और Make या n8n जैसे टूल में रिस्पॉन्स फॉर्मेट JSON पर सेट करें।

ऑथेंटिकेशन से जुड़े आम एरर:

संदेश	मतलब
`Auth Error`	`client_id` या `api_key` मौजूद नहीं है, बॉडी सही JSON या फॉर्म डेटा नहीं है, या रिक्वेस्ट `POST` नहीं थी।
`Auth Error - Please send correct API key and Client id`	`api_key` मौजूद नहीं है या खाली है।
`Invalid client id.` या `Invalid Client Id`	`client_id` पूर्ण संख्या नहीं है (या, कुछ एंडपॉइंट पर, मौजूद नहीं है)। इसे नंबर के रूप में भेजें, जैसे `12345`।
`Auth Error: invalid api key`	की मौजूद नहीं है, डिलीट कर दी गई है, या इस `client_id` की नहीं है।
`Demo Account can not access apis`	डेमो अकाउंट API का इस्तेमाल नहीं कर सकते।
`Not enough credits`	आपके प्लान में कोई संदेश नहीं बचा है। अपग्रेड करें या अगले बिलिंग साइकिल का इंतज़ार करें।

संदेश का लाइफसाइकिल#

API से भेजे गए संदेश पहले कतार (queue) में जाते हैं, फिर आपके WhatsApp नंबर से भेजे जाते हैं। हर संदेश का इनमें से कोई एक स्टेटस होता है:

स्टेटस	नाम	मतलब
`0`	Created	कतार में है और भेजे जाने का इंतज़ार कर रहा है।
`1`	Sent	आपके WhatsApp नंबर से भेज दिया गया।
`2`	Failed	नहीं भेजा जा सका, उदाहरण के लिए क्योंकि नंबर WhatsApp पर नहीं है।
`3`	Cancelled	भेजे जाने से पहले कैंसल कर दिया गया।
`4`	Expired	अपनी `expire_after_seconds` समय-सीमा से पहले नहीं भेजा जा सका।

कतार में रखे संदेश भेजे जाने के लिए आपका WhatsApp नंबर कनेक्टेड रहना चाहिए। जिस नंबर से आप भेजते हैं, अगर वह डिसकनेक्ट है, तो उसके संदेश तब तक कतार में रहते हैं जब तक नंबर दोबारा कनेक्ट न हो जाए या संदेश एक्सपायर न हो जाएं। डिसकनेक्ट नंबर के न भेजे गए संदेश 90 दिनों के बाद हटा दिए जाते हैं।

किसी संदेश को ट्रैक करने के लिए, रिस्पॉन्स से msg_id सेव करें और फिर संदेश भेजते समय webhook URL पास करें, या संदेश स्टेटस कॉल करें।

आधिकारिक क्लाइंट लाइब्रेरी#

Python और Node.js के लिए रैपर आपके लिए ऑथेंटिकेशन और फाइल अपलोड संभालते हैं। ये अभी हर एंडपॉइंट को सही ढंग से कवर नहीं करते, इसलिए किसी क्लाइंट मेथड पर भरोसा करने से पहले हर एंडपॉइंट का पेज जांचें।

pip install wbiztool-client

npm install wbiztool-client

Python: PyPI पर wbiztool-client
Node.js: npm पर wbiztool-client

बिना कोड के सेटअप करना चाहते हैं? Zapier, n8n, Make, Pabbly Connect, Google Sheets, Shopify और WordPress के लिए ऐप्स और इंटीग्रेशन देखें।

डॉक्स देखें#

प्रोडक्ट गाइड: Wbiztool डैशबोर्ड इस्तेमाल करें, नंबर कनेक्ट करने से लेकर कैंपेन, रिमाइंडर और Unibox तक।
मैसेजिंग API: संदेश भेजें, शेड्यूल करें, कैंसल करें और ट्रैक करें।
WhatsApp अकाउंट API: नंबर कनेक्ट करें और उनका स्टेटस जांचें।
नंबर वेरिफिकेशन API: बल्क में जांचें कि कौन-से नंबर WhatsApp पर हैं।
रिमाइंडर API: बार-बार आने वाले रिमाइंडर बनाएं, उनकी सूची देखें और उन्हें कैंसल करें।
मीडिया API: फाइलें अपलोड करें, फिर उनकी सूची देखें या उन्हें पाएं।
इंटीग्रेशन: नो-कोड और प्लगइन सेटअप।