افزودن گروهی کارمندان (Post: Upload User Whitelist)
برای اضافه کردن گروهی کارمندان به کد تخفیف از طریق فایل استفاده می‌شود.
اطلاعات عمومی
- آدرس:
/api/v2/purchased-voucher/{id}/user-whitelist/upload - متد:
POST - نوع محتوا:
multipart/form-data - احراز هویت: نیازمند token
احراز هویت
- این درخواست نیاز به یک Authorization token دارد که باید در هدر ارسال شود.
پارامترهای مسیر
| پ ارامتر | نوع داده | ضروری | توضیحات |
|---|---|---|---|
| id | integer | بله | شناسه کد تخفیف خریداری‌شده |
پارامترهای فرم (Form Data)
| فیلد | نوع داده | ضروری | توضیحات |
|---|---|---|---|
| csv | file | بله | فایل CSV حاوی لیست کاربران برای افزودن به لیست سفید |
توضیحات فایل CSV:
- فایل CSV باید شامل یک ستون با عنوان
cellphoneباشد که شماره تلفن همراه کاربران در آن قرار دارد. - فرمت شماره تلفن‌ها باید به صورت رشته‌ای و قابل خواندن باشد.
- هر خط فایل CSV باید شامل اطلاعات یک کاربر باشد.
نمونه درخواست
curl --location --request POST 'https://corporate.snapp.site/api/v2/purchased-voucher/5113/user-whitelist/upload' \
--header 'Authorization: <your_authorization_token>' \
--form 'csv=@"/path/to/your/users.csv"'
پاسخ موفق
{
"message": "OK",
"status": 0
}
توضیحات فیلدهای پاسخ
| فیلد | نوع داده | توضیحات |
|---|---|---|
| message | string | پیام کلی پاسخ (مثلاً "OK") |
| status | integer | کد وضعیت پاسخ (0 برای موفقیت) |
خطاها
| کد وضعیت | توضیحات |
|---|---|
400 | درخواست نامعتبر (ورودی‌های اشتباه) |
401 | نیاز به احراز هویت |
403 | دسترسی غیرمجاز |
404 | کد تخفیف موردنظر یافت نشد |
500 | خطای داخلی سرور |