ఫలితాలను పేజీలుగా విభజించడం
పెద్దవిగా మారగల జాబితాలు కొత్త అంశాలు ముందుగా ఉండేలా ఒక్కో పేజీగా అందుతాయి: తరువాతి పేజీ ఎక్కడ మొదలవుతుందో ప్రతి పేజీ సూచిస్తుంది. మిగిలిన జాబితాలు పూర్తిగా అందుతాయి.
కర్సర్ ఆధారిత పేజీలు
సందేశాలు, ఇమెయిల్ టెంప్లేట్లు, విఫలమైన webhook డెలివరీలు కర్సర్ ద్వారా పేజీలుగా విభజించబడతాయి:
- పేరు
limit- టైప్ చేయండి
- integer
- వివరణ
ఒక పేజీలోని అంశాల సంఖ్య, 1 నుంచి 100 వరకు; డిఫాల్ట్ సంఖ్య 25.
- పేరు
cursor- టైప్ చేయండి
- string
- వివరణ
మొదటి పేజీ కోసం దీన్ని పంపవద్దు; తరువాత మునుపటి పేజీ నుంచి వచ్చిన
nextవిలువను మార్చకుండా పంపండి.
ప్రతి పేజీలో దాని అంశాలు, next ఉంటాయి; చివరి పేజీలో అది null అవుతుంది. కర్సర్లోని విషయాన్ని అర్థం చేసుకోవడానికి ప్రయత్నించకుండా ఉపయోగించండి. ప్రతి జాబితాకు దాని స్వంత కర్సర్ను మాత్రమే పంపండి: జాబితాల మధ్య ఆకృతులు భిన్నంగా ఉంటాయి; కర్సర్ కాని విలువను 400 BAD_REQUESTతో తిరస్కరిస్తారు.
అన్ని సందేశాలు, ఒక్కో పేజీగా
cursor=''
while :; do
page=$(curl -sG https://api.oblic.app/external/v1/messages \
-H 'Authorization: Bearer YOUR_API_KEY' \
-d limit=100 ${cursor:+-d cursor="$cursor"})
echo "$page" | jq -c '.data.messages[]'
cursor=$(echo "$page" | jq -r '.data.next // empty')
[ -z "$cursor" ] && break
done
కర్సర్ తన పేజీలోని చివరి అంశాన్ని సూచిస్తుంది. అందువల్ల పేజీలు చదువుతున్నప్పుడు జోడించిన అంశాలు తరువాతి పేజీలను మార్చవు: కొత్త అంశాలు ప్రారంభంలో వస్తాయి; మొదటి పేజీ నుంచి మళ్లీ చదివితే అవి లభిస్తాయి.
పరిచయాల జాబితాలు
పరిచయాల జాబితాలు పాత్లోని ఆఫ్సెట్ ద్వారా పేజీలుగా విభజించబడతాయి: /external/contact-list/v1/{nextIndex}/{limit}. 0 నుంచి ప్రారంభించండి; మరిన్ని ఫలితాలు ఉన్నాయా లేదా అని ప్రతి పేజీ moreIndicatorలో తెలియజేస్తుంది (Y లేదా N); తరువాతి పేజీ ఎక్కడ మొదలవుతుందో nextIndexలో తెలియజేస్తుంది.
పూర్తి జాబితాలు
పంపినవారి గుర్తింపులు, webhook ఎండ్పాయింట్లు, ఉపఖాతాలు, SMS హెడర్లు, టెంప్లేట్లు, WhatsApp టెంప్లేట్లు పేజీలుగా విభజించకుండా పూర్తిగా అందుతాయి.