پرش به مطلب اصلی

لغو تخصیص شماره

این API به شما امکان لغو تخصیص شماره از یک کاربر زیرمجموعه را می‌دهد.

دقت داشته باشید که این API صرفا برای ریسلرهای سامانه در دسترس بوده و کاربران عادی به آن دسترسی ندارند.

📍 لینک دسترسی

POST {base_url}/api/numbers/unassign

🧾 هدرها

کلیدمقدار
Authorizationتوکن یا کلید دسترسی
Content-Typeapplication/json

📤 بدنه درخواست

{
"number_id": 10,
"target_user_id": 123,
"number": "+983000505",
"target_user": "testuser"
}

📝 پارامترها

پارامترنوعاجباریتوضیحات
number_idintegerبلهشناسه شماره‌ای که قرار است تخصیصش لغو شود.
target_user_idintegerبلهشناسه کاربری که شماره از او لغو تخصیص خواهد شد.
numberstringخیرشماره در فرمت E.164 که قرار است تخصیصش لغو شود.
target_userstringخیرنام کاربری که شماره از او لغو تخصیص خواهد شد.

📝 نکات

  • number_id در صورتی که number ارائه نشده باشد اجباری است.
  • target_user_id در صورتی که target_user ارائه نشده باشد اجباری است.
  • number در صورتی که number_id ارائه نشده باشد اجباری است.
  • target_user در صورتی که target_user_id ارائه نشده باشد اجباری است.

✅ پاسخ موفق

{
"data": null,
"meta": {
"status": true,
"message": "انجام شد",
"message_parameters": [],
"message_code": "200-1"
}
}

❌ پاسخ خطا — توکن نامعتبر یا منقضی (401)

{
"data": null,
"meta": {
"status": false,
"message": "اطلاعات وارد شده صحیح نمی باشد",
"message_parameters": [],
"message_code": "400-1",
"errors": {}
}
}

❌ پاسخ خطا — درخواست نامعتبر (422)

{
"data": null,
"meta": {
"status": false,
"message": "تکمیل گزینه number id الزامی است (و 1 خطای دیگر)",
"message_parameters": [],
"message_code": "400-2",
"errors": {
"number_id": [
"تکمیل گزینه number id الزامی است"
],
"number": [
"تکمیل گزینه number الزامی است"
]
}
}
}

❌ پاسخ خطا — درخواست نامعتبر (400)

{
"data": null,
"meta": {
"status": false,
"message": "number not assigned to user",
"message_parameters": [],
"message_code": "400-1",
"errors": {}
}
}

🧪 نمونه درخواست

curl --location '{base_url}/api/numbers/unassign' \
--header 'Content-Type: application/json' \
--header 'Authorization: Your Apikey/Token' \
--data '{
"number_id": 10,
"target_user_id": 123
}'