Senders

Get list of senders

get

Retrieve a list of senders with optional pagination and search

Query parameters

allbooleanOptional

Get all senders without pagination

searchstringOptional

Search term for filtering senders

per_pageintegerOptional

Number of items per page

Default: 15

pageintegerOptional

Page number

Default: 1

Responses

200

Successful operation

application/json

dataobject[]Optional

401

Unauthenticated

get

/api/SmsUsers/senders/

GET /api/SmsUsers/senders/ HTTP/1.1
Accept: */*

{
  "data": [
    {}
  ],
  "pagination": {
    "total": 1,
    "per_page": 1,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1
  }
}

Get sender details

get

Retrieve details of a specific sender

Path parameters

idinteger · int64Required

ID of the sender to retrieve

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: senders

dataobjectOptional

401

Unauthenticated

404

Sender not found

application/json

get

/api/SmsUsers/senders/{id}

GET /api/SmsUsers/senders/{id} HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "senders",
  "data": {}
}

Update a sender

put

Update an existing sender's information

Path parameters

idinteger · int64Required

ID of the sender to update

Body

namestring · max: 14Optional

file_authorization_letterstring · binaryOptional

file_commercial_registerstring · binaryOptional

file_value_added_tax_certificatestring · binaryOptional

file_otherstring · binaryOptional

notestring · max: 255Optional

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: senders

dataobjectOptional

400

Bad request

application/json

401

Unauthenticated

403

Forbidden

404

Sender not found

put

/api/SmsUsers/senders/{id}

PUT /api/SmsUsers/senders/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "name": "text",
  "file_authorization_letter": "binary",
  "file_commercial_register": "binary",
  "file_value_added_tax_certificate": "binary",
  "file_other": "binary",
  "note": "text"
}

{
  "success": true,
  "message": "senders",
  "data": {}
}

Delete a sender

delete

Delete a specific sender for the authenticated user

Path parameters

idinteger · int64Required

ID of the sender to delete

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Sender deleted successfully

400

Sender not found

application/json

401

Unauthenticated

delete

/api/SmsUsers/senders/{id}

DELETE /api/SmsUsers/senders/{id} HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Sender deleted successfully"
}

Create a new sender

post

Authorizations

Body

namestring · max: 14RequiredExample: Sender Name

file_authorization_letterstring · binaryRequired

file_commercial_registerstring · binaryOptional

file_value_added_tax_certificatestring · binaryOptional

file_otherstring · binaryRequired

notestring · max: 255Optional

side_typeinteger · enumOptionalPossible values:

side_namestringOptional

typestringOptional

commercial_registerstringOptional

delegate_namestringOptional

delegate_emailstringOptional

max_sms_one_dayintegerOptional

Responses

201

Sender created successfully

application/json

400

Validation error

application/json

post

/api/SmsUsers/senders

POST /api/SmsUsers/senders HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 318

{
  "name": "Sender Name",
  "file_authorization_letter": "binary",
  "file_commercial_register": "binary",
  "file_value_added_tax_certificate": "binary",
  "file_other": "binary",
  "note": "text",
  "side_type": 1,
  "side_name": "text",
  "type": "text",
  "commercial_register": "text",
  "delegate_name": "text",
  "delegate_email": "text",
  "max_sms_one_day": 1
}

{
  "success": true,
  "message": "Sender created successfully",
  "data": {}
}

Delete multiple senders

delete

Delete multiple senders for the authenticated user

Body

idsinteger[]RequiredExample: [1,2,3]

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Senders deleted successfully

400

Bad request

application/json

401

Unauthenticated

delete

/api/SmsUsers/deleteSelectedsenders

DELETE /api/SmsUsers/deleteSelectedsenders HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "ids": [
    1,
    2,
    3
  ]
}

{
  "success": true,
  "message": "Senders deleted successfully"
}

Update default sender

get

Set a sender as default and unset others

Path parameters

idinteger · int64Required

ID of the sender to set as default

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Sender updated successfully

400

Bad request

application/json

401

Unauthenticated

404

Sender not found

get

/api/SmsUsers/updateDefault/{id}

GET /api/SmsUsers/updateDefault/{id} HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Sender updated successfully"
}

Buy sender using bank transfer

post

Process the purchase of a sender using bank transfer

Path parameters

idinteger · int64Required

ID of the sender to purchase

Body

receipt_attachfileOptional

Receipt attachment (jpg, jpeg, png, pdf, max 2MB)

Responses

201

Successful operation

application/json

401

Payment not available

application/json

422

Validation error

application/json

post

/api/SmsUsers/buy_sender_bank/{id}

POST /api/SmsUsers/buy_sender_bank/{id} HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 23

{
  "receipt_attach": null
}

{
  "success": true,
  "message": "Payment successful",
  "data": {
    "payment_bank_id": 1,
    "user_id": 1,
    "sender_id": 1
  }
}

Buy sender using wallet balance

get

Purchase a sender using the user's wallet balance

Path parameters

idinteger · int64Required

ID of the sender to purchase

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Sender purchased successfully

dataobjectOptional

400

Bad request

application/json

401

Unauthenticated

404

Sender not found

application/json

get

/api/SmsUsers/buySenderWallet/{id}

GET /api/SmsUsers/buySenderWallet/{id} HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Sender purchased successfully",
  "data": {}
}

Initiate payment for a sender via payment gateway

get

Creates a payment request for a sender using Urway payment gateway

Path parameters

idinteger · int64Required

ID of the sender to purchase

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Payment Url

datastringOptionalExample: https://payments.urway-tech.com/URWAYPGService/direct.jsp?paymentid=123456789

401

Payment failed

application/json

404

Sender not found

get

/api/SmsUsers/buy_senders_gateway/{id}

GET /api/SmsUsers/buy_senders_gateway/{id} HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Payment Url",
  "data": "https://payments.urway-tech.com/URWAYPGService/direct.jsp?paymentid=123456789"
}

Get user senders

get

Retrieve active senders for a user, including granted senders

Query parameters

allbooleanOptional

Get all senders without pagination

user_idintegerOptional

ID of the user to get senders for

searchstringOptional

Search term for filtering senders

per_pageintegerOptional

Number of items per page

Default: 15

pageintegerOptional

Page number

Default: 1

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: items

401

Unauthenticated

get

/api/SmsUsers/user_sender

GET /api/SmsUsers/user_sender HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "items",
  "data": {
    "items": [
      {}
    ],
    "selected": [
      {
        "id": 1,
        "name": "text"
      }
    ]
  }
}

Get SMS senders for the authenticated user

get

Retrieves active senders, all senders, or a default sender for the authenticated user

Authorizations

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: items

401

Unauthenticated

get

/api/SmsUsers/getSmsSenders

GET /api/SmsUsers/getSmsSenders HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "items",
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "name": "SenderName",
      "side_name": "text",
      "side_type": "text",
      "type": "text",
      "commercial_register": "text",
      "unified_number": "text",
      "is_sent_to_hawsabah": true,
      "status": 1,
      "default": "static",
      "date": "2026-03-23T06:26:21.993Z",
      "created_at": "2026-03-23T06:26:21.993Z"
    }
  ]
}

Get wallet associated with a payment sender

get

Path parameters

idintegerRequired

ID of the payment sender

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

walletobjectOptional

404

Wallet not found

application/json

get

/api/SmsUsers/paymentsender/{id}/wallet

GET /api/SmsUsers/paymentsender/{id}/wallet HTTP/1.1
Accept: */*

{
  "success": true,
  "wallet": {}
}

PreviousRevision Messages NextSMS

Last updated 9 months ago

hashtagGet list of senders

hashtagGet sender details

hashtagUpdate a sender

hashtagDelete a sender

hashtagCreate a new sender

hashtagDelete multiple senders

hashtagUpdate default sender

hashtagBuy sender using bank transfer

hashtagBuy sender using wallet balance

hashtagInitiate payment for a sender via payment gateway

hashtagGet user senders

hashtagGet SMS senders for the authenticated user

hashtagGet wallet associated with a payment sender

Get list of senders

Get sender details

Update a sender

Delete a sender

Create a new sender

Delete multiple senders

Update default sender

Buy sender using bank transfer

Buy sender using wallet balance

Initiate payment for a sender via payment gateway

Get user senders

Get SMS senders for the authenticated user

Get wallet associated with a payment sender