सहेजी सूची कार्रवाई जाँचें

GET/account/api/v1/residential/lists/status

प्राधिकरण

Authorization	`Bearer YOUR_ARNPROXY_API_KEY`
आवश्यक अनुमति	`residential_management`
Accept	`application/json`
Idempotency-Key	16–100 अक्षर, अंक, _ या -। एक ही कार्रवाई के लिए मान सहेजकर दोबारा उपयोग करें।

पैरामीटर

नाम	प्रकार	विवरण
`Idempotency-Key` headerआवश्यक	`string`	16–100 अक्षर/अंक/_/-। कार्रवाई और स्थिति में समान मान रखें; अलग बॉडी में पुनः उपयोग न करें।

अनुरोध उदाहरण

cURL

printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    --header 'Idempotency-Key: YOUR_SAVED_OPERATION_KEY' \
    'https://www.arnproxy.com/account/api/v1/residential/lists/status'

इस पेज पर उदाहरण नहीं चलते। API कुंजी सर्वर की पर्यावरण चर में रखें, URL या ब्राउज़र कोड में नहीं। POST के लिए request.json तैयार करें।

उत्तर

200सफल उत्तर

application/json

{
    "ok": true,
    "data": {
        "state": "completed",
        "list_id": 30001,
        "action": "rename",
        "requested_value": "Example connection list",
        "write_sent": true,
        "reason": null,
        "replayed": true,
        "updated_at": 1893499200,
        "next_action": null
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}

उत्तर के फ़ील्ड और प्रकार

नाम	प्रकार	विवरण
`ok`	`boolean`	सफलता संकेत; false पर error.code देखें।
`data`	`object`	कार्रवाई-विशिष्ट परिणाम; उदाहरण कृत्रिम और समझाने के लिए हैं।
`data.state`	`string`	रिकॉर्ड/कार्रवाई स्थिति। accepted डिलीवरी नहीं; completed कनेक्शन परीक्षण नहीं।
`data.list_id`	`integer`	संबंधित ARNPROXY रिकॉर्ड ID; आंतरिक प्रदाता ID के बदले इसे लें।
`data.action`	`string`	action का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.requested_value`	`string`	requested value का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.write_sent`	`boolean`	write sent का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.reason`	`string\|null`	निश्चित कारण कोड या null, मूल प्रदाता त्रुटि पाठ नहीं।
`data.replayed`	`boolean`	उसी कार्रवाई का सहेजा परिणाम लौटा, नए शुल्क/कार्रवाई का प्रमाण नहीं।
`data.updated_at`	`integer`	Residential सेटिंग में Unix सेकंड; अन्य परिणाम में दिखाया प्रारूप बनाए रखें।
`data.next_action`	`string\|null`	next action का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`meta`	`object`	अनुरोध संबद्धता और डेटा-स्रोत मेटाडेटा।
`meta.request_id`	`string`	इस HTTP अनुरोध की पहचान; कार्रवाई कुंजी या ऑर्डर ID नहीं।
`meta.phase`	`string`	phase का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`meta.source`	`string`	डेटा स्रोत; स्थानीय रिकॉर्ड और लाइव प्रदाता क्वेरी अलग प्रमाण हैं।

त्रुटि उत्तर

HTTP 401 · INVALID_API_KEY

{
  "ok": false,
  "error": { "code": "INVALID_API_KEY" },
  "meta": { "request_id": "000000000000000000000001" }
}

प्रमाणीकरण और जाँच निष्पादन से पहले अनुरोध रोक सकते हैं। त्रुटि संदर्भ देखें और सहायता के लिए request_id रखें। कुंजी या पासवर्ड न भेजें। त्रुटियाँ और सीमाएँ →

व्यवहार और महत्वपूर्ण नोट

पैकेज/सूची ID ARNPROXY रिकॉर्ड ID हैं, प्रदाता कुंजियाँ नहीं। पुराना स्नैपशॉट पहुँच नहीं देता; ज़रूरत पर residential_package_refresh लें।