API thuê số

API là giao thức để truyền thông giữa phần mềm của bạn và máy chủ thuê số của chúng tôi.

Mô tả Giao thức API

Tất cả các yêu cầu phải được gửi đến https://api.sms-man.com/rent-api/ yêu cầu GET. Tất cả các yêu cầu phải bao gồm khóa API như một tham số token. Tất cả các câu trả lời đều được trả về dưới định dạng json.

Yêu cầu số dư

Các thông số

Tham số	Loại	Bắt buộc	Giá trị
`token`	String	Có	Khóa API của bạn

Kết quả

{
  "balance": "799.70"
}

Lỗi có thể xảy ra

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

Nhận giới hạn

Các thông số

Tham số	Loại	Bắt buộc	Giá trị
`token`	String	Có	Khóa API của bạn
`country_id`	Integer	Có
`type`	String	Có	`hour` / `day` / `week` / `month`
`time`	String	Có	Thời gian thuê

Kết quả

{
  "type": "hour",
  "time": "4",
  "limits": [
    {"country_id":"1","count":"127","cost":"151.68"},
    {"country_id":"2","count":"49","cost":"113.56"},
    {"country_id":"4","count":"0","cost":"151.68"}
  ]
}

Lỗi có thể xảy ra

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

Đặt mua số để thuê

Các thông số

Tham số	Loại	Bắt buộc	Giá trị
`token`	String	Có	Khóa API của bạn
`country_id`	Integer	Có
`type`	String	Có	`hour` / `day` / `week` / `month`
`time`	String	Có	Thời gian thuê

Kết quả

{
  "request_id": 1,
  "country_id": 1,
  "number": "79002415539"
}

Lỗi có thể xảy ra

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

Đặt thuê số một phần

Các thông số

Tham số	Loại	Bắt buộc	Giá trị
`token`	String	Có	Khóa API của bạn
`country_id`	Integer	Có
`application_id`	Integer	Có
`type`	String	Có	`hour` / `day` / `week` / `month`
`time`	String	Có	Thời gian thuê

Kết quả

{
  "request_id": 1,
  "country_id": 1,
  "application_id": 1,
  "number": "79002415539"
}

Lỗi có thể xảy ra

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

Thay đổi trạng thái

Các thông số

Tham số	Loại	Bắt buộc	Giá trị
`token`	String	Có	Khóa API của bạn
`request_id`	Integer	Có	ID yêu cầu
`status`	String	Có	`close` - chấm dứt thuê

Kết quả

{
  "request_id": 1,
  "success": true
}

Lỗi có thể xảy ra

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

Nhận tin nhắn cuối cùng

Các thông số

Tham số	Loại	Bắt buộc	Giá trị
`token`	String	Có	Khóa API của bạn
`request_id`	Integer	Có	ID yêu cầu

Kết quả

{
  "request_id": "10",
  "country_id": 1,
  "number": "79633002801",
  "sms": {"message":"message","code":"code","time":"2020-12-12 14:50:31"}
}

Lỗi có thể xảy ra

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

Nhận tất cả tin nhắn SMS

Các thông số

Tham số	Loại	Bắt buộc	Giá trị
`token`	String	Có	Khóa API của bạn
`request_id`	Integer	Có	ID yêu cầu

Kết quả

{
  "request_id": "10",
  "country_id": 1,
  "number": "79633002801",
  "sms": [
    {"message":"message","code":"code","time":"2020-12-12 14:50:31"}
  ]
}

Lỗi có thể xảy ra

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

Lấy danh sách tất cả các số

Các thông số

Tham số	Loại	Bắt buộc	Giá trị
`token`	String	Có	Your API KEY

Kết quả

[
  {"id":1,"country_id":1,"number":"79002415539","status":"cancel"}
]

Lỗi có thể xảy ra

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}