पेजिनेशन
API के सूची एंडपॉइंट डेटा पेज-दर-पेज लौटाते हैं। प्लेटफ़ॉर्म में ऐतिहासिक रूप से पेजिनेशन की दो स्कीमें विकसित हुई हैं; विशिष्ट स्कीमा इंटरेक्टिव संदर्भ में एंडपॉइंट पर दर्शाई गई है।
स्कीमा 1 — offset और X-Total-Count
offset द्वारा क्लासिक पेजिनेशन। अनुरोध query पैरामीटर limit (पेज आकार) और offset (कितने रिकॉर्ड छोड़ने हैं) स्वीकार करता है:
curl -H "Authorization: Bearer mbp_आपका_टोकन" "https://your-domain/api/bots/BOT_ID/subscribers?limit=50&offset=100"
रिकॉर्ड की कुल संख्या रिस्पॉन्स हेडर X-Total-Count में लौटाई जाती है। इससे पेजों की संख्या की गणना होती है: offset को X-Total-Count के मान से कम होने तक limit से बढ़ाते हुए पेज करें। रिस्पॉन्स बॉडी वर्तमान पेज के elements का array है।
स्कीमा 2 — before कर्सर और has_more
समय के अनुसार क्रमबद्ध फ़ीड (जैसे, डायलॉग संदेश) के लिए कर्सर पेजिनेशन। अनुरोध limit और वैकल्पिक कर्सर before — अंतिम प्राप्त element का पहचानकर्ता या टाइमस्टैम्प — स्वीकार करता है:
curl -H "Authorization: Bearer mbp_आपका_टोकन" "https://your-domain/api/bots/BOT_ID/users/USER_ID/dialog?limit=50&before=CURSOR"
रिस्पॉन्स में elements का पेज और has_more फ़्लैग होता है। जब तक has_more true है, before में अंतिम प्राप्त element का कर्सर पास करते हुए अनुरोध दोहराएँ। जब has_more false हो जाए — यह अंतिम पेज है।
कौन सी स्कीमा चुनें
आप स्कीमा नहीं चुनते — यह एंडपॉइंट तय करता है। संदर्भ सूचियाँ आमतौर पर offset और X-Total-Count उपयोग करती हैं; समय-आधारित फ़ीड — before कर्सर और has_more। हमेशा संदर्भ में एंडपॉइंट पेज से मिलान करें।
आगे क्या
- API क्विकस्टार्ट — पहले अनुरोध।
- एरर — स्टेटस कोड।
- सीमाएँ और आकार — अनुरोध सीमाएँ।