Papo (https://papo.global/) के साथ, आप REST API का उपयोग करके बातचीत सूचीबद्ध कर सकते हैं, टेक्स्ट संदेश भेज सकते हैं, टैग लागू कर सकते हैं और बातचीत एजेंटों को असाइन कर सकते हैं, बिना इंटरफ़ेस में जाए सेवा प्रक्रियाओं को स्वचालित करते हुए। API ऐसे endpoints प्रदान करती है जो Conversations मॉड्यूल की कार्यक्षमताओं को दर्शाते हैं, जिससे बाहरी सिस्टम प्रोग्रामेटिक रूप से इंटरैक्शन प्रबंधित कर सकते हैं।
| API क्रिया | यह क्या करती है | उपयोग का उदाहरण |
|---|---|---|
| बातचीत सूचीबद्ध करें | खाते की बातचीत लौटाता है, स्थिति, टैग या एजेंट के फ़िल्टर के साथ | किसी बाहरी CRM से सक्रिय या बंद सेवाओं की निगरानी करें |
| टेक्स्ट संदेश भेजें | किसी संपर्क को टेक्स्ट संदेश भेजता है (WhatsApp की 24 घंटे की विंडो का पालन करते हुए) | ऑर्डर अपडेट के बारे में ग्राहक को सूचित करें |
| टैग लागू करें | टैग बनाता है (यदि मौजूद न हो) और उसे संपर्क तथा खुली बातचीत पर लागू करता है | बातचीत को स्वचालित रूप से “अत्यावश्यक” या “पोस्ट-सेल्स” के रूप में चिह्नित करें |
| बातचीत असाइन करें | किसी संपर्क की खुली बातचीत किसी विशिष्ट एजेंट को असाइन करता है | लीड्स को क्षेत्र के जिम्मेदार विक्रेता की ओर भेजें |
Papo की बातचीत API कैसे काम करती है
Papo की API REST पैटर्न का पालन करती है, जिसमें गुप्त कुंजी (Bearer token) से प्रमाणीकरण और JSON में प्रतिक्रियाएँ होती हैं। यहाँ वर्णित सभी ऑपरेशन एक ही प्रमाणीकरण बेस का उपयोग करते हैं और स्वचालित वर्कफ़्लो बनाने के लिए संयोजित किए जा सकते हैं — उदाहरण के लिए, एक ट्राइएज सिस्टम जो नया लीड मिलने पर हाल की बातचीत सूचीबद्ध करता है, “नया” टैग लागू करता है और ड्यूटी पर मौजूद एजेंट को असाइन करता है।
API का बेस https://app.papo.global/api/v1 है। बातचीत, टैग और असाइनमेंट के endpoints का उपयोग करने के लिए, आपको Papo पैनल में जनरेट किया गया API token चाहिए। विशिष्ट endpoints और पैरामीटर वाला पूरा दस्तावेज़ papo.global/pt/docs पर उपलब्ध है।
API सुविधाओं का उपयोग करने के लिए चरण-दर-चरण
1. API token जनरेट करें
Papo पैनल में, डेवलपर सेक्शन या एक्सेस tokens पर जाएँ। बातचीत प्रबंधित करने के लिए उपयुक्त अनुमतियों वाली गुप्त कुंजी (sk_live_…) बनाएँ। Token को सुरक्षित स्थान पर रखें — यह सभी अनुरोधों के Authorization हेडर में भेजा जाएगा।
2. बातचीत सूचीबद्ध करें
खाते की सेवाएँ प्राप्त करने के लिए बातचीत लिस्टिंग endpoint का उपयोग करें। अनुरोध निम्न फ़िल्टर पैरामीटर स्वीकार करता है:
- स्थिति: खुली, बंद या सभी बातचीत।
- टैग: लागू किए गए एक या अधिक टैग से फ़िल्टर करें।
- एजेंट: किसी विशिष्ट उपयोगकर्ता को असाइन की गई बातचीत तक सीमित करें।
- अवधि: क्वेरी सीमित करने के लिए तिथि अंतराल।
प्रतिक्रिया में बातचीत का पहचानकर्ता, संपर्क, चैनल, स्थिति और अंतिम संदेश शामिल होते हैं। इन डेटा के साथ, आप सेवा वॉल्यूम की निगरानी कर सकते हैं या बाहरी सिस्टम से सशर्त क्रियाएँ ट्रिगर कर सकते हैं।
3. टेक्स्ट संदेश भेजें
किसी संपर्क को टेक्स्ट संदेश भेजने के लिए, संदेश भेजने वाले endpoint का उपयोग करें। अनुरोध के लिए आवश्यक है:
- प्राप्तकर्ता का नंबर अंतर्राष्ट्रीय प्रारूप में (उदा.:
5511999999999)। - संदेश का टेक्स्ट।
- इंस्टेंस पहचानकर्ता (वैकल्पिक) — यदि आपके खाते में एक से अधिक WhatsApp कनेक्शन हैं, तो आप निर्दिष्ट कर सकते हैं कि किसका उपयोग करना है।
API पुष्टि लौटाती है कि अनुरोध स्वीकार कर लिया गया है। याद रखें कि टेक्स्ट संदेश भेजना WhatsApp की 24 घंटे की विंडो के अधीन है; इस अवधि के बाहर संचार के लिए, पहले से स्वीकृत संदेश टेम्पलेट (HSM) का उपयोग करना आवश्यक है।
4. संपर्कों और बातचीत पर टैग लागू करें
API टैग को दो तरीकों से प्रबंधित करने देती है:
- खाते में टैग बनाएँ: नए टैग के लिए शीर्षक, रंग और विवरण निर्धारित करें।
- टैग लागू करें: किसी मौजूदा टैग को संपर्क और उस संपर्क की खुली बातचीत से जोड़ें। यदि टैग अभी मौजूद नहीं है, तो लागू करते समय वह स्वचालित रूप से बन जाएगा।
यह आपके सिस्टम के नियमों के आधार पर बातचीत को स्वचालित रूप से वर्गीकृत करने के लिए उपयोगी है — उदाहरण के लिए, जब ग्राहक कोई विशिष्ट कीवर्ड भेजे तो “शिकायत” के रूप में चिह्नित करना।
5. बातचीत एजेंटों को असाइन करें
असाइनमेंट endpoint के साथ, आप किसी निर्दिष्ट संपर्क की सभी खुली बातचीत के लिए एक एजेंट नियुक्त कर सकते हैं। बस संपर्क का पहचानकर्ता और उपयोगकर्ता/एजेंट की ID बताएँ। खाते की एजेंट सूची उपयोगकर्ता लिस्टिंग endpoint से प्राप्त की जा सकती है, जो टीम के प्रत्येक सदस्य का नाम, ई-मेल और ID लौटाता है।
यह सुविधा स्वचालित रूटिंग के लिए आवश्यक है: एक CRM सिस्टम लीड की प्रोफ़ाइल पहचानकर उसे बिना मैन्युअल हस्तक्षेप के सही विक्रेता को असाइन कर सकता है।
बातचीत API का उपयोग किसे करना चाहिए
- ऐसे ऑपरेशन जो पहले से बाहरी सिस्टम (ERP, CRM, ई-कॉमर्स प्लेटफ़ॉर्म) का उपयोग करते हैं और दोहराव के बिना Papo की सेवा को एकीकृत करना चाहते हैं।
- जटिल रूटिंग नियमों वाली सपोर्ट टीमें, जिन्हें ग्राहक डेटा के आधार पर बातचीत को स्वचालित रूप से वर्गीकृत और निर्देशित करना होता है।
- कस्टम डैशबोर्ड बनाने वाले डेवलपर्स या सेवा इवेंट से सूचनाएँ ट्रिगर करने वाले।
- White label रीसेलर, जो कई खाते प्रबंधित करते हैं और प्रत्येक ग्राहक के लिए टैग और असाइनमेंट की सेटिंग स्वचालित करना चाहते हैं।
अक्सर पूछे जाने वाले प्रश्न
इन endpoints का उपयोग करने के लिए मुझे API token चाहिए?
हाँ। Papo API के सभी अनुरोधों के लिए गुप्त कुंजी से प्रमाणीकरण आवश्यक है, जिसे Authorization: Bearer sk_live_… हेडर में भेजा जाता है। Tokens खाता पैनल में जनरेट किए जाते हैं।
क्या API WhatsApp की 24 घंटे की विंडो के बाहर संदेश भेज सकती है?
API द्वारा टेक्स्ट संदेश भेजना 24 घंटे की विंडो का पालन करता है। इस अवधि के बाहर सक्रिय संचार के लिए, स्वीकृत संदेश टेम्पलेट (HSM) का उपयोग करना आवश्यक है। Papo HSM भेजने के लिए विशिष्ट endpoints प्रदान करती है।
क्या मैं टैग के अनुसार बातचीत सूचीबद्ध कर सकता हूँ?
हाँ। बातचीत लिस्टिंग endpoint टैग के अनुसार फ़िल्टर स्वीकार करता है, जिससे आप केवल एक या अधिक विशिष्ट टैग वाली सेवाएँ प्राप्त कर सकते हैं।
मैं API के माध्यम से किसी संपर्क पर टैग कैसे लागू करूँ?
टैग endpoint का उपयोग करें, जिसमें टैग का पहचानकर्ता (या बनाने के लिए डेटा) और संपर्क का पहचानकर्ता बताएँ। टैग संपर्क और उससे संबंधित खुली बातचीत पर लागू हो जाएगा।
क्या API बातचीत का पूरा इतिहास लौटाती है?
बातचीत लिस्टिंग मेटाडेटा और अंतिम संदेश लौटाती है। किसी विशिष्ट बातचीत के संदेशों का पूरा इतिहास प्राप्त करने के लिए, API दस्तावेज़ देखें, जो संदेश पुनर्प्राप्ति endpoints का विवरण देता है।
क्या उपयोगकर्ता की ID जाने बिना बातचीत किसी एजेंट को असाइन की जा सकती है?
आप पहले खाते के उपयोगकर्ताओं को सूचीबद्ध कर सकते हैं (एजेंट endpoint) ताकि IDs प्राप्त हों, और फिर असाइनमेंट endpoint का उपयोग करें। एजेंट सूची में नाम और ई-मेल शामिल होते हैं, जिससे पहचान आसान होती है।
यह भी पढ़ें
- अपने white label रीसेल के ग्राहकों को प्रबंधित करने के लिए Papo API का उपयोग कैसे करें
- संपर्कों की कस्टम विशेषताओं को प्रबंधित करने के लिए Papo API का उपयोग कैसे करें
Papo के API और सभी मॉड्यूल बिना लागत के आज़माएँ — पहला उपयोगकर्ता मुफ़्त है और क्रेडिट कार्ड की आवश्यकता नहीं है।