हमारे रेस्टफुल एपीआई के साथ कैरियर-ग्रेड संचार वर्कफ़्लो बनाएं। HTTPS पर JSON, बियरर टोकन ऑथ, और रीयल-टाइम वेबहुक।
curl -X POST https://api.ajoxi.com/v1/calls \
-H "Authorization: Bearer AJX_LIVE_..." \
-H "Content-Type: application/json" \
-d '{ "to": "+14155551234", "from": "+14155550100", "ai_receptionist": true }'{
"id": "call_8f2a1b3c",
"status": "ringing",
"ai_handler": "receptionist_v2"
}सभी अनुरोध बियरर टोकन के साथ प्रमाणित होते हैं Authorization शीर्षक. अपने Ajoxiकंसोल के एपीआई टैब से कुंजी उत्पन्न करें - उपयोग करें AJX_LIVE_… उत्पादन यातायात के लिए और AJX_TEST_… सैंडबॉक्स के लिए.
curl https://api.ajoxi.com/v1/calls \
-H "Authorization: Bearer AJX_LIVE_XXXXX"वॉइस कॉल रखें, सूचीबद्ध करें, स्थानांतरित करें और पुनः प्राप्त करें।
/v1/callsकर्सर पेजिनेशन और दिनांक फ़िल्टर के साथ सभी कॉलों को सूचीबद्ध करें।
/v1/callsएक नई आउटबाउंड कॉल आरंभ करें या डायलर अभियान ट्रिगर करें।
/v1/calls/{id}संपूर्ण मेटाडेटा के साथ आईडी द्वारा एकल कॉल पुनर्प्राप्त करें।
/v1/calls/{id}/transferकिसी सक्रिय कॉल को किसी अन्य एजेंट या एक्सटेंशन को स्थानांतरित करें।
फ़ोन नंबर खोजें, प्रावधान करें, पोर्ट करें और जारी करें।
/v1/numbersउपलब्ध स्थानीय, टोल-फ़्री, या अंतर्राष्ट्रीय नंबर खोजें।
/v1/numbersअपने खाते में एक नया नंबर प्रदान करें.
/v1/numbers/{id}किसी नंबर पर रूटिंग, कॉलर-आईडी या एसएमएस कॉन्फ़िगरेशन अपडेट करें।
/v1/numbers/{id}पूल में वापस एक नंबर जारी करें। अपरिवर्तनीय.
एसएमएस, एमएमएस और वार्तालाप इतिहास भेजें और प्राप्त करें।
/v1/messagesसंदेशों को सूचीबद्ध करें, दिशा, चैनल या बातचीत के अनुसार फ़िल्टर करें।
/v1/messagesएक एसएमएस या एमएमएस भेजें. मीडिया अनुलग्नकों और टेम्पलेट्स का समर्थन करता है।
कॉल रिकॉर्डिंग, ट्रांसक्रिप्ट और एआई-जनरेटेड अंतर्दृष्टि तक पहुंचें।
/v1/recordingsवैकल्पिक दिनांक और एजेंट फ़िल्टर के साथ कॉल रिकॉर्डिंग सूचीबद्ध करें।
/v1/recordings/{id}प्रतिलेख और एआई सारांश के साथ एकल रिकॉर्डिंग पुनः प्राप्त करें।
/v1/transcripts/{id}किसी कॉल या रिकॉर्डिंग के लिए पूर्ण प्रतिलिपि पुनर्प्राप्त करें।
रीयल-टाइम प्लेटफ़ॉर्म ईवेंट की सदस्यता लें।
/v1/webhooksकॉन्फ़िगर की गई वेबहुक सदस्यताओं की सूची बनाएं.
/v1/webhooksएक या अधिक ईवेंट की सदस्यता लें (कॉल.स्टार्ट, संदेश.प्राप्त)।
/v1/webhooks/{id}वेबहुक सदस्यता हटाएँ.
प्रत्येक त्रुटि प्रतिक्रिया JSON को एक के साथ लौटाती है error.code और error.message. HTTP स्थिति कोड श्रेणी से मेल खाता है।
मानक खातों को प्रति एपीआई कुंजी प्रति सेकंड 100 अनुरोधों पर सीमित किया गया है। एंटरप्राइज़ योजनाओं की कोई निश्चित सीमा नहीं है - हम आपके ट्रैफ़िक के अनुसार मापते हैं। प्रत्येक प्रतिक्रिया में तीन दर-सीमा शीर्षलेख शामिल होते हैं:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 87
X-RateLimit-Reset: 1715800000जब सीमा पार हो जाती है तो आपको a के साथ 429 प्रतिक्रिया प्राप्त होती है Retry-After सेकंड में हेडर. एसडीके क्लाइंट इन हेडर के विरुद्ध स्वचालित रूप से घातीय बैकऑफ़ लागू करते हैं।
सूची समापन बिंदु डिफ़ॉल्ट रूप से प्रति पृष्ठ अधिकतम 50 आइटम लौटाते हैं (200 तक कॉन्फ़िगर करने योग्य)। ?limit=200). प्रत्येक प्रतिक्रिया में एक शामिल है next_cursor - इसे इस रूप में वापस पास करें ?cursor=… अगला पृष्ठ पुनः प्राप्त करने के लिए. कब next_cursor शून्य है, आप अंत तक पहुंच गए हैं.
{
"data": [ ... ],
"next_cursor": "Y3Vyc29yX2FmMmI...",
"has_more": true
}हस्ताक्षरित HTTPS POSTs के माध्यम से प्लेटफ़ॉर्म ईवेंट की सदस्यता लें। प्रत्येक वेबहुक अनुरोध में एक शामिल है X-Ajoxi-Signature हेडर - अपने वेबहुक सीक्रेट का उपयोग करके इसे कच्चे अनुरोध निकाय पर HMAC-SHA256 के रूप में सत्यापित करें।
call.startedजब कोई इनबाउंड या आउटबाउंड कॉल बजना शुरू हो जाती है तो सक्रिय हो जाता है।call.answeredजब कॉल का उत्तर किसी मानव या एआई रिसेप्शनिस्ट द्वारा दिया जाता है तो निकाल दिया जाता है।call.completedकॉल समाप्त होने पर निकाल दिया जाता है. पेलोड में अवधि, रिकॉर्डिंग यूआरएल और अंतिम निपटान शामिल है।message.receivedजब कोई इनबाउंड एसएमएस या एमएमएस किसी प्रावधानित नंबर पर आता है तो सक्रिय हो जाता है।message.deliveredजब वाहक द्वारा आउटबाउंड संदेश की पुष्टि की जाती है तो सक्रिय किया जाता है।recording.readyजब कॉल रिकॉर्डिंग संसाधित हो जाती है और डाउनलोड के लिए उपलब्ध हो जाती है तो सक्रिय हो जाती है।transcript.readyजब किसी रिकॉर्डिंग के लिए AI ट्रांस्क्रिप्ट की प्रोसेसिंग पूरी हो जाती है तो सक्रिय हो जाता है।विफल डिलीवरी 24 घंटे तक घातीय बैकऑफ़ के साथ पुनः प्रयास करें। अंतिम प्रयास के बाद, ईवेंट को एक मृत-अक्षर कतार में ले जाया जाता है जिसे आप कंसोल से पुनः चला सकते हैं।
वर्तमान स्थिर संस्करण है v1. ब्रेकिंग परिवर्तन एक नए उपसर्ग के अंतर्गत भेजे जाते हैं (/v2/, आदि) - मौजूदा संस्करण के अंदर कभी नहीं। अस्वीकृत संस्करण उत्तराधिकारी जहाजों के बाद कम से कम 18 महीने तक उपलब्ध रहते हैं, सूर्यास्त से पहले 6 महीने की ईमेल चेतावनी के साथ।
प्रथम-पक्ष SDK Node.js, Python, Go और Ruby के लिए उपलब्ध हैं। प्रत्येक जहाज टाइप किए गए क्लाइंट, पुनः प्रयास तर्क और ए के साथ आता है verifyWebhook() सहायक.
सभी अनुरोध बियरर-टोकन प्रमाणीकरण का उपयोग करते हैं। Ajoxiकंसोल में एक API कुंजी जेनरेट करें, फिर इसे प्रत्येक अनुरोध पर `प्राधिकरण: बियरर AJX_LIVE_XXXXX` के रूप में पास करें। सैंडबॉक्स ट्रैफ़िक के लिए एक अलग `AJX_TEST_…` कुंजी का उपयोग करें - परीक्षण वातावरण अलग-थलग है और कभी भी वास्तविक कॉल नहीं करता है।
हाँ। परीक्षण-मोड कुंजियों के साथ की गई कॉलें लाइव कैरियर नेटवर्क के बजाय हमारे सिम्युलेटर के माध्यम से रूट की जाती हैं - सीआई पाइपलाइनों और लोड परीक्षण के लिए बिल्कुल सही। टेस्ट-मोड अनुरोध आपके मिनट भत्ते के विरुद्ध बिल नहीं देते हैं और कभी भी वास्तविक फ़ोन नहीं बजाते हैं।
मानक योजना पर प्रति सेकंड 100 अनुरोध, उद्यम पर असीमित। प्रत्येक प्रतिक्रिया में `X-RateLimit-Limit`, `X-RateLimit-Remaining`, और `X-RateLimit-Reset` हेडर शामिल होते हैं ताकि आप अपने ट्रैफ़िक को सटीक रूप से गति दे सकें। जब आप सीमा पार कर जाते हैं तो आपको 'पुनः प्रयास-आफ्टर' मान के साथ 429 प्राप्त होता है।
प्रत्येक वेबहुक अनुरोध में एक `X-Ajoxi-Signature` हेडर शामिल होता है। अपने वेबहुक सीक्रेट का उपयोग करके कच्चे अनुरोध निकाय पर HMAC-SHA256 की गणना करें, फिर दो मानों की स्थिर-समय की तुलना करें। एसडीके क्लाइंट (नोड, पायथन, गो, रूबी) एक `verifyWebhook()` हेल्पर के साथ आते हैं जो आपके लिए इसे संभालता है।
हम कभी भी स्थिर एपीआई संस्करण को नहीं तोड़ते। ब्रेकिंग परिवर्तन एक नए संस्करण पथ के अंतर्गत भेजे जाते हैं (जैसे `/v2/`)। किसी उत्तराधिकारी के भेजे जाने के बाद अप्रचलित संस्करण कम से कम 18 महीने तक लाइव रहते हैं, और किसी भी सूर्यास्त से पहले आपको कम से कम 6 महीने की ईमेल चेतावनियाँ प्राप्त होती हैं।
फिलहाल नहीं. एपीआई REST + JSON है जिसमें लाइव ट्रांसक्रिप्ट जैसे एंडपॉइंट स्ट्रीमिंग के लिए वैकल्पिक सर्वर-भेजे गए इवेंट हैं। यदि ग्राफक्यूएल आपके लिए एक विशिष्ट वर्कफ़्लो को अनब्लॉक करेगा, तो अपनी खाता टीम के माध्यम से एक अनुरोध दर्ज करें - हम मांग को ट्रैक करते हैं और तदनुसार प्राथमिकता देते हैं।
एक सैंडबॉक्स कुंजी स्पिन करें, एक एसडीके स्थापित करें, और दोपहर के भोजन से पहले अपना पहला प्रोग्रामयोग्य कॉल करें।