API, Playground और webhooks से शुरुआत करें
API कुंजी खोजें, पहला अनुरोध सुरक्षित रूप से भेजें और क्रेडेंशियल उजागर किए बिना इवेंट सूचनाएँ जोड़ें।
मौजूदा API संदर्भ इस्तेमाल करें
लॉगिन के बाद खोलें API दस्तावेज़। इसमें समर्थित एंडपॉइंट, ज़रूरी फ़ील्ड और उदाहरण हैं। अनुरोध के विवरण इसी से लें; यह गाइड प्रक्रिया समझाती है, एंडपॉइंट का पूरा विवरण दोहराती नहीं।
कुंजी तैयार करें
कुंजी देखने या कॉपी करने के लिए पहचान सत्यापन पूरा करें। इसके बाद दस्तावेज़ में पाँच मिनट तक कुंजी देखना और Playground चलाना संभव है; कुंजी बनाने या फिर से बनाने के लिए नया सत्यापन चाहिए। इसे पासवर्ड की तरह सुरक्षित रखें: ऐप्लिकेशन के सर्वर पर रखें, सार्वजनिक रिपॉज़िटरी, ब्राउज़र कोड या स्क्रीनशॉट में नहीं।
पहला अनुरोध सुरक्षित रूप से भेजें
- Playground खोलें और खाते के अनुसार केवल पढ़ने वाला प्रीसेट चुनें, जैसे SIP पहचान की सूची।
- मेथड, पाथ और पैरामीटर जाँचें। उदाहरण की जगह अपने खाते के जवाब में मिले पहचानकर्ता इस्तेमाल करें।
- चुनें Run request और HTTP स्थिति व जवाब की बॉडी, दोनों देखें।
- दस्तावेज़ वाला अनुरोध उदाहरण अपनी ऐप्लिकेशन में इस्तेमाल करें और क्रेडेंशियल सुरक्षित रखें।
Playground आपका खाता इस्तेमाल करता है। संदेश भेजने, कॉल करने या सेवा ऑर्डर करने वाले अनुरोध असली काम कर सकते हैं और शुल्क लगा सकते हैं। इसे मुफ़्त सैंडबॉक्स न समझें।
Webhook सूचनाएँ जोड़ें
खाते के इंटीग्रेशन में HTTPS एंडपॉइंट जोड़ें और ज़रूरी इवेंट चुनें। Webhook का साइनिंग सीक्रेट API कुंजी से अलग है। हस्ताक्षर जाँचें, हर इवेंट एक बार प्रोसेस करें और जल्दी प्राप्ति की पुष्टि भेजें। समस्या में डिलीवरी लॉग देखें। किसी भुगतान वाली कार्रवाई को दोहराने से पहले API के रीट्राई और डुप्लिकेट अनुरोध नियम पढ़ें; केवल टाइमआउट विफलता का प्रमाण नहीं है।
संबंधित गाइड
सही सेवा का संदर्भ चुनें
संदर्भ में Lookup, Pricing, SIP, SMS, Contacts, Speech API, Phone Numbers, Voice API और Calls & recordings अलग हैं। सही शर्तें, फ़ील्ड और शुल्क संबंधित एंडपॉइंट में देखें। ब्राउज़र कॉलिंग की अलग Webphone SDK गाइड है; यह सर्वर की Voice API कॉल कंट्रोल से अलग है।
एजेंट को API दस्तावेज़ पढ़ने की अनुमति मिलने से मालिक की API कुंजी या कुंजी से चलने वाला Playground नहीं मिलता। मालिक का लॉगिन साझा करने के बजाय उन्हीं से इंटीग्रेशन क्रेडेंशियल सँभालने को कहें।
मिले हुए संदर्भ और पेजिनेशन इस्तेमाल करें
सार्वजनिक कॉल संदर्भ को बिना बदलाव वाला मान समझें: अपने जवाब से पूरा CALL- संदर्भ कॉपी करें, खुद न बनाएँ और आंतरिक फ़ोन सिस्टम पहचानकर्ता न लें। पुरानी और सक्रिय कॉल अलग सूचियाँ हैं। कंट्रोल कार्रवाई के लिए समर्थित कॉल स्थिति भी चाहिए; हिस्ट्री की पुरानी पंक्ति पर कंट्रोल संभव होना ज़रूरी नहीं।
कॉल हिस्ट्री में pagination.has_more सही रहने तक pagination.next_cursor लें। मूल days, limit और SIP पहचान फ़िल्टर न बदलें। कर्सर डिकोड या संशोधित न करें। समाप्त होने पर नई सूची शुरू करें और सार्वजनिक कॉल संदर्भ से मिलान करें। API में UTC बताया गया टाइमस्टैम्प दिखाने के लिए स्पष्ट रूप से बदलना होगा; वह अपने आप ब्राउज़र का स्थानीय समय नहीं बनता।
भुगतान वाली कार्रवाई दोहराए बिना त्रुटि सँभालें
HTTP स्थिति और संरचित त्रुटि साथ पढ़ें। दोबारा कोशिश से पहले वैलिडेशन या अनुमति की त्रुटियाँ ठीक करें। रेट लिमिट पर दस्तावेज़ में दिया इंतज़ार करें। भुगतान वाली कार्रवाई में टाइमआउट या अस्थायी त्रुटि आए तो दोबारा भेजने से पहले स्थिति और एंडपॉइंट के डुप्लिकेट नियम देखें; पहचानकर्ता बदलने से नया काम बन सकता है। सपोर्ट के लिए सार्वजनिक अनुरोध या संदर्भ, समय और संवेदनशील जानकारी हटाकर त्रुटि रखें, API कुंजी कभी नहीं।