API tương thích

API là giao thức tương tác giữa phần mềm của bạn và máy chủ kích hoạt của chúng tôi. API cần thiết để tự động hóa quá trình nhận tin nhắn SMS từ phía bạn. Để làm việc với API, bạn phải sử dụng khóa API của bạn, bạn có thể nhận nó trong phần hồ sơ của bạn, sau khi hoàn tất quy trình đăng ký đơn giản. API của chúng tôi hoàn toàn tương thích với các trang web cạnh tranh.

Mô tả Giao thức API

Tất cả các yêu cầu phải gửi đến https://api.sms-man.com/stubs/handler_api.php yêu cầu POST hoặc GET. Tất cả các yêu cầu phải chứa khóa API dưới dạng tham số api_key. Tất cả các câu trả lời đều trong đị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ị
`action`	String	Có	`getBalance`
`api_key`	String	Có	Khóa API của bạn

Kết quả

ACCESS_BALANCE:$balance (trong đó $balance là số dư của tài khoản của bạn)

Lỗi có thể xảy ra

Lỗi	Mô tả
`BAD_KEY`	Khóa API không chính xác

Nhận giá hiện tại

Các thông số

Tham số	Loại	Bắt buộc	Giá trị
`action`	String	Có	`getPrices`
`api_key`	String	Có	Khóa API của bạn
`country`	Number	Không
`service`	String	Không

Kết quả

{
  "0": {"vk":{"cost":"15","count":6455},"wb":{"cost":"50","count":124}},
  "1": {"fb":{"cost":"6","count":1000}}
}

Lỗi có thể xảy ra

Lỗi	Mô tả
`BAD_KEY`	Khóa API không chính xác

Nhận số

Các thông số

Tham số	Loại	Bắt buộc	Giá trị
`action`	String	Có	`getNumber`
`api_key`	String	Có	Khóa API của bạn
`country`	Number	Có
`service`	String	Có
`maxPrice`	Number	Không	giá trị bạn muốn
`currency`	String	Không	`RUB/USD/EUR`
`ref`	String	Không	Vui lòng cung cấp ID giới thiệu.

Kết quả

ACCESS_NUMBER:$id:$number
$id - id kích hoạt
$number - số điện thoại

Lỗi có thể xảy ra

Lỗi	Mô tả
`BAD_KEY`	Khóa API không chính xác
`NO_NUMBERS`	Không có số, hãy thử lại sau
`NO_BALANCE`	Số dư thấp

Nhận trạng thái kích hoạt

Các thông số

Tham số	Loại	Bắt buộc	Giá trị
`action`	String	Có	`getStatus`
`api_key`	String	Có	Khóa API của bạn
`id`	Number	Có	ID kích hoạt

Kết quả

STATUS_WAIT_CODE - đang chờ tin nhắn SMS
STATUS_WAIT_RETRY:$lastcode - đang chờ làm rõ mã (trong đó $lastcode - mã cuối cùng không thành công)
STATUS_WAIT_RESEND — đang chờ việc gửi lại SMS (phần mềm sẽ nhấn gửi lại SMS và thực hiện thay đổi trạng thái thành 6)
STATUS_CANCEL — Việc kích hoạt đã bị hủy bỏ
STATUS_OK:$code — Mã nhận được (nơi $code là mã kích hoạt)

Lỗi có thể xảy ra

Lỗi	Mô tả
`BAD_KEY`	Khóa API không chính xác
`NO_ACTIVATION`	Không có kích hoạt

Nhận trạng thái kích hoạt V2

Các thông số

Tham số	Loại	Bắt buộc	Giá trị
`action`	String	Có	`getStatusV2`
`api_key`	String	Có	Khóa API của bạn
`id`	Number	Có	ID kích hoạt

Kết quả

{
  "verificationType": 0,
  "sms": {"dateTime":"0000-00-00 00:00:00","code":"code","text":"sms text"}
}

STATUS_CANCEL

STATUS_WAIT_CODE

Lỗi có thể xảy ra

Lỗi	Mô tả
`BAD_KEY`	Khóa API không chính xác
`NO_ACTIVATION`	Không có kích hoạt

Thay đổi trạng thái kích hoạt

Các thông số

Tham số	Loại	Bắt buộc	Giá trị
`action`	String	Có	`setStatus`
`api_key`	String	Có	Khóa API của bạn
`id`	Number	Có	ID kích hoạt
`status`	Number	Có	Trạng thái kích hoạt

Trạng thái có thể

-1 — Hủy kích hoạt
1 — Thông báo rằng SMS đã được gửi (tùy chọn)
3 — Yêu cầu một mã khác
6 — hoàn tất việc kích hoạt (nếu trạng thái là "nhận mã" - đánh dấu thành công và hoàn tất, nếu trạng thái là "chuẩn bị" - xóa và đánh dấu lỗi, nếu trạng thái là "đợi nhận lại" - chuyển kích hoạt sang chờ tin nhắn SMS)
8 — thông báo rằng số đã được sử dụng và hủy kích hoạt

Kết quả

ACCESS_READY - Số đã sẵn sàng xử dụng
ACCESS_RETRY_GET - đang chờ tin nhắn SMS mới
ACCESS_ACTIVATION - dịch vụ đã được kích hoạt thành công
ACCESS_CANCEL - Kích hoạt đã bị hủy
EARLY_CANCEL_DENIED - Không được phép hủy số trong 2 phút đầu tiên.

Lỗi có thể xảy ra

Lỗi	Mô tả
`BAD_KEY`	Khóa API không chính xác
`NO_ACTIVATION`	ID kích hoạt không tồn tại
`BAD_STATUS`	Trạng thái không chính xác

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

Các thông số

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

Kết quả

[
  {"id":0,"name":"Россия","name_en":"Russia"},
  {"id":3,"name":"Китай","name_en":"China"}
]

Lỗi có thể xảy ra

Lỗi	Mô tả
`BAD_KEY`	Khóa API không chính xác

Lấy danh sách tất cả các dịch vụ

Các thông số

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

Kết quả

[
  {"id":"vk","name":"Вконтакте"},
  {"id":"wb","name":"WeChat"},
  {"id":"tg","name":"Telegram"}
]

Lỗi có thể xảy ra

Lỗi	Mô tả
`BAD_KEY`	Khóa API không chính xác
`BAD_ACTION`	Hành động không chính xác