Skip to main content

Voice OTP

Tích hợp và sử dụng Voice OTP

Mục đích

Cho phép sử dụng Alice Voice OTP từ bên thứ 3

API chi tiết

Tất cả API request tới hệ thống Alice:

Thông qua tên miền

https://alice.antbuddy.com/rest-api

authorize header bắt buộc:

Authorization: Bearer {access_token}

Get AccessToken

Endpoint: /get-token/
Method: POST
Body: {
"username": "username",
"password": "password"
}

Description:
Username: tên hoặc email đã tạo bên antbuddy
Password: mật khẩu

Tạo yêu cầu gọi

API tạo yêu cầu đọc mã cho số điện thoại:

Xem các cuộc gọi otp hiện có

Endpoint: /voice-otp/
Method: GET

Tạo cuộc gọi otp

Endpoint: /voice-otp/
Method: POST
Body: {
"alarm_phonenumber": "0919273027",
"otp": "123445",
"maxretry": 0
}

Miêu tả:
- alarm_phonenumber: Số điện thoại muốn nhận mã code (bắt buộc)
- otp: Mã code muốn gửi tới số điện thoại, nếu trống hoặc không gửi, hệ thống tự động tạo một mã code trải nghiệm.
- maxretry: số lần đọc lại mã , mặc định là 0, tương ứng với 1 lần đọc.