وضعیت پردازش مخاطبان بارگذاری‌شده

وضعیت پردازش یک بارگذاری مخاطب را برمی‌گرداند: مرحلهٔ پردازش، شناسه و نام سگمنت ساخته‌شده و تعداد رکوردهای کل، نامعتبر و تکراری. تا زمانی که پردازش تمام نشده باشد ممکن است segment_id و segment_name مقدار null داشته باشند. با ارسال with_malformed_contacts=true فهرست شماره‌های نامعتبر نیز در پاسخ گنجانده می‌شود.

احراز هویت

نوع احراز هویتتوکن BearerbearerAuth

کلید API را در هدر Authorization با پیشوند Bearer بفرستید:

``` Authorization: Bearer YOURAPIKEY ```

این روش برای سرویس‌های نسخهٔ ۲، نسخهٔ ۳ و بارگذاری فایل به کار می‌رود. سرویس‌های نسخهٔ ۱ کلید را از مسیر URL می‌گیرند و هدری نمی‌خواهند.

هدر لازم

Authorization: Bearer YOUR_ACCESS_TOKEN

کلید خود را کجا پیدا کنم؟

اطلاعات ورود را از پنل کاربری خود بگیرید و توکن را فقط روی سرور و در یک متغیر محیطی نگه دارید؛ هرگز آن را در کد سمت کاربر قرار ندهید.

پارامترهای مسیر

نام	نوع	الزامی	توضیح
`upload_data_id`*	integer	الزامی	شناسهٔ بارگذاری که از پاسخ سرویس بارگذاری مخاطبان (`upload_data_id`) گرفته می‌شود. اگر عدد صحیح نباشد خطای ۴۰۰ برمی‌گردد. نمونه`20`

پارامترهای کوئری

نام	نوع	الزامی	توضیح
`with_malformed_contacts`	string	اختیاری	اگر برابر `true` باشد، فهرست شماره‌های نامعتبر در فیلد `malformed_contacts` بازگردانده می‌شود. هر مقدار دیگری معادل `false` در نظر گرفته می‌شود و در آن حالت `malformed_contacts` مقدار `null` دارد. — اگر برابر `true` باشد، فهرست شماره‌های نامعتبر در فیلد `malformed_contacts` بازگردانده می‌شود. هر مقدار دیگری معادل `false` در نظر گرفته می‌شود و در آن حالت `malformed_contacts` مقدار `null` دارد. محدودیت: فقط مقدار `true` (بدون حساسیت به بزرگی و کوچکی حروف) فعال‌کننده است مقادیر مجاز`truefalse`پیش‌فرض`false`نمونه`true`

پاسخ‌ها

ساختار پاسخ

نام	نوع	الزامی	توضیح
`return`	ApiStatus	اختیاری	وضعیت پاسخ. مقدار `status` با کد وضعیت HTTP پاسخ یکسان است.
`status`*	integer	الزامی	کد وضعیت — همان کد وضعیت HTTP پاسخ. نمونه`200`
`message`*	string	الزامی	پیام فارسی قابل نمایش به کاربر. نمونه`درخواست تایید شد.`
`entries`	GetUploadDataStatusResponse	اختیاری
`status`	string	اختیاری	وضعیت پردازش بارگذاری. نمونه`PROCESSED`
`segment_id`	integer	اختیاری	شناسهٔ سگمنت؛ تا پایان پردازش `null` است. نمونه`10`می‌تواند null باشد
`segment_name`	string	اختیاری	نام خودکار سگمنت به شکل `API_<uuid>`. می‌تواند null باشد
`total_records_count`	integer	اختیاری	تعداد کل رکوردهای بارگذاری‌شده. نمونه`100`
`invalid_records_count`	integer	اختیاری	تعداد رکوردهای نامعتبر. نمونه`2`
`duplicate_records_count`	integer	اختیاری	تعداد رکوردهای تکراری. نمونه`3`
`malformed_contacts`	array<string>	اختیاری	شماره‌های نامعتبر — فقط وقتی `with_malformed_contacts=true` باشد. می‌تواند null باشد

نمونهٔ پاسخ

{
  "return": {
    "status": 200,
    "message": "درخواست تایید شد."
  },
  "entries": {
    "status": "PROCESSED",
    "segment_id": 10,
    "segment_name": "API_9f1c0d2e-7b3a-4a12-9f0e-2c5b8d4e1a77",
    "total_records_count": 100,
    "invalid_records_count": 2,
    "duplicate_records_count": 3,
    "malformed_contacts": null
  }
}