Assign Number

This API allows you to assign a number to a user.

📍 Endpoint

POST {base_url}/api/numbers/assign

🧾 Headers

Key	Value
Authorization	YOUR_TOKEN_HERE
Content-Type	application/json

📤 Request Body

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

📝 Parameters

Parameter	Type	Required	Description
number_id	integer	Yes	The ID of the number to be assigned.
target_user_id	integer	Yes	The ID of the user to whom the number will be assigned.
number	string	No	The number in E.164 format to be assigned.
target_user	string	No	The username of the user to whom the number will be assigned.
send	boolean	Yes	If true, user can send messages with this number.
gets	boolean	Yes	If true, user can receive messages with this number.

📝 Notes

• number_id Required if number is not provided.
• target_user_id Required if target_user is not provided.
• number Required if number_id is not provided.
• target_user Required if target_user_id is not provided.
• gets the user will be able to receive/view incoming messages for this number. Typically true for dedicated numbers.

✅ Success Response

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

❌ Error Response — Invalid or Expired Token (401)

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

❌ Error Response — Invalid Request (422)

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

❌ Error Response — Invalid Request (400)

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

🧪 Example Request

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