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

تخصیص شماره به کاربر زیرمجوعه

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

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

📍 لینک دسترسی

POST {base_url}/api/numbers/assign

🧾 هدرها

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

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

{
"number_id": 10,
"target_user_id": 123,
"number": "+983000505",
"target_user": "testuser",
"send": true,
"gets": false
}

📝 پارامترها

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

📝 نکات

  • number_id در صورتی که number ارائه نشده باشد اجباری است.
  • target_user_id در صورتی که target_user ارائه نشده باشد اجباری است.
  • number در صورتی که number_id ارائه نشده باشد اجباری است.
  • target_user در صورتی که target_user_id ارائه نشده باشد اجباری است.
  • gets کاربر قادر خواهد بود پیام‌های ورودی این شماره را دریافت/مشاهده کند. معمولاً برای شماره‌های اختصاصی true است.

✅ پاسخ موفق

{
"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 already assigned to user",
"message_parameters": [],
"message_code": "400-1",
"errors": {}
}
}

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

curl --location '{base_url}/api/numbers/assign' \
--header 'Content-Type: application/json' \
--header 'Authorization: Your Apikey/Token' \
--data '{
"number": "+983000505",
"target_user": "testuser",
"send": true,
"gets": false
}'