Skip to main content
GET
एक messaging प्लेटफ़ॉर्म के लिए संदेश या वार्तालाप प्राप्त करें। प्रत्येक सोशल नेटवर्क पर retrieval समय भिन्न होते हैं। Facebook, Instagram, और WhatsApp पर, संदेश Ayrshare के माध्यम से वास्तविक समय में उपलब्ध हैं। X/Twitter पर, नए संदेश अद्यतन देखने के लिए 3 मिनट तक की देरी होती है। यदि आपको वास्तविक-समय X/Twitter संदेश पहुँच की आवश्यकता है तो Enterprise Plan के बारे में अधिक जानने के लिए कृपया सहायता से संपर्क करें।
Response caching: Facebook और Instagram के लिए, responses को 60 सेकंड के लिए cache किया जाता है। X/Twitter के लिए, polling का बेहतर समर्थन करने के लिए responses को 15 सेकंड के लिए cache किया जाता है। WhatsApp Meta webhooks के माध्यम से पहले से प्राप्त संदेशों को पढ़ता है, इसलिए एक नया प्राप्त संदेश Ayrshare के उसके webhook को प्रोसेस करते ही दिखाई दे सकता है। Response में lastUpdated और nextUpdate metadata अब भी शामिल है।
Facebook और Instagram के लिए प्रारंभिक संदेश इतिहास पुनर्प्राप्ति पिछले 20 संदेशों तक सीमित है। अधिक जानकारी के लिए कृपया Facebook और Instagram के लिए संदेश इतिहास पुनर्प्राप्ति अनुभाग देखें।
WhatsApp बातचीत को correspondent के फ़ोन नंबर द्वारा पहचाना जाता है (केवल अंक, शुरुआती + के बिना E.164)। एक संग्रहीत outbound संदेश में status मान sent, delivered, read, या failed हो सकता है।
Send Message के माध्यम से भेजे गए WhatsApp संदेश वर्तमान में Get Messages इतिहास में नहीं जोड़े जाते। Webhooks के माध्यम से प्राप्त इनकमिंग WhatsApp संदेश यहाँ संग्रहीत और लौटाए जाते हैं।

Header Parameters

Path Parameters

string
आवश्यक
संदेश प्राप्त करने के लिए प्लेटफ़ॉर्म: facebook, instagram, twitter, whatsapp

Query Parameters

string
डिफ़ॉल्ट:"active"
आवश्यक
Active वार्तालाप या archived वार्तालाप लौटाएँ। मान: active या archived।
string
केवल विशिष्ट वार्तालाप लौटाएँ।
string
केवल एक दिशा के संदेश लौटाएँ। मान: sent या received। दोनों लौटाने के लिए इसे छोड़ दें।
boolean
डिफ़ॉल्ट:false
संदेशों के बजाय वार्तालाप लौटाता है। वार्तालापों का एक पेज लौटाता है — बाकी के लिए meta.pagination.next का अनुसरण करें। true होने पर conversationId अनदेखा कर दिया जाता है।
जब conversationsOnly=true है, तो वार्तालाप विवरण converstationsDetails में लौटाए जाते हैं। यह वर्तनी वर्तमान API response का हिस्सा है।
integer
संदेशों और वार्तालाप सूचियों के लिए पेज आकार: 1 से 100 तक पूर्णांक, डिफ़ॉल्ट और अधिकतम 100।X/Twitter पर limit यह भी तय करता है कि आप कौन-सा संदेश-समूह पढ़ेंगे। इसे छोड़ने पर आपके संग्रहीत संदेश पेज-दर-पेज मिलते हैं — यही बाकी सभी प्लेटफ़ॉर्म करते हैं और यहीं status, action तथा conversationsOnly लागू होते हैं। इसे देने पर इसके बजाय X की लाइव टाइमलाइन X के अपने कर्सर से पढ़ी जाती है, जिसमें ये तीनों फ़िल्टर लागू नहीं होते।यह चुनाव केवल पहले अनुरोध में होता है। एक बार कर्सर का अनुसरण शुरू करने पर कर्सर ही तय करता है: संग्रहीत संदेशों का कर्सर limit भेजने पर भी संग्रहीत संदेश ही लौटाता रहेगा, और X का कर्सर limit छोड़ने पर भी लाइव टाइमलाइन ही लौटाता रहेगा। पेजिनेशन के बीच में दोनों के बीच अदला-बदली संभव नहीं है।
string
meta.pagination.next से अपारदर्शी कर्सर। इसे उसी प्रोफ़ाइल, प्लेटफ़ॉर्म और फ़िल्टर के साथ next के रूप में भेजें। meta.pagination.hasMore के true रहने तक जारी रखें, चाहे कोई फ़िल्टर किया पेज छोटा या खाली आए। बाद के अनुरोधों में limit छोड़ा जा सकता है (डिफ़ॉल्ट 100); X/Twitter पर कर्सर स्वयं दर्ज रखता है कि वह किस समूह से आया है, इसलिए limit भेजने या छोड़ने से आप दूसरे समूह पर नहीं चले जाएँगे।

अगला पृष्ठ प्राप्त करना

GET /api/messages/instagram?limit=100 से शुरू करें। जारी रखने के लिए, लौटाए गए meta.pagination.next मान को URL-encode करें और GET /api/messages/instagram?limit=100&next=<opaque cursor> भेजें। पैरामीटर next है, cursor नहीं। पूरे समय एक ही Profile-Key और query फ़िल्टर बनाए रखें। कब रुकना है यह तय करने के लिए परिणामों की संख्या नहीं, बल्कि meta.pagination.hasMore जाँचें। फ़िल्टर किया गया अनुरोध limit से कम परिणाम लौटा सकता है, या continuation के साथ एक खाली पृष्ठ भी, क्योंकि प्रत्येक अनुरोध इतिहास का एक सीमित हिस्सा ही स्कैन करता है। संग्रहीत इतिहास में संदेश नवीनतम-पहले क्रम में होते हैं, और बराबरी की स्थिति में document ID से क्रम तय होता है। वार्तालाप सूचियाँ document ID के क्रम में होती हैं। Paging कोई स्थिर snapshot नहीं है: पहले पृष्ठ से फिर से शुरू करने पर नए संदेश दिखाई देते हैं, और वार्तालाप की स्थितियाँ बदलने से फ़िल्टर किए गए परिणाम बदल सकते हैं। मौजूदा संदेश फ़ील्ड और converstationsDetails वर्तनी अपरिवर्तित हैं। जो integrations पहले एक ही अनुरोध से पूरी सूची — चाहे संदेशों की हो या वार्तालापों की, किसी भी प्लेटफ़ॉर्म पर — मिलने की अपेक्षा करते थे, उन्हें अब continuation कर्सर का अनुसरण करना होगा; limit को 100 से ऊपर बढ़ाना समर्थित नहीं है।