Ủy quyền của nhà điều hành và liên kết sâu
Hướng dẫn này giải thích cách lấy mã thông báo ủy quyền hợp lệ cho người vận hành trong hệ thống thông qua API và cách sử dụng liên kết sâu để điều hướng đến bảng trò chuyện.
URL cơ sở API: https://chatapi.smsbat.com/
Swagger: https://chatapi.smsbat.com/index.html
Lưu ý: Bạn có thể sử dụng tiêu đề
X-Authorization-Keyvới mã thông báo của mình (có sẵn trong Hồ sơ của bạn trên trang tổng quan) thay vì ủy quyềnBearercho các yêu cầu cấp công ty.
1. Lấy mã thông báo của công ty
Để nhận mã thông báo của công ty, hãy gửi yêu cầu HTTP POST tới /api/company/get-token chứa thông tin đăng nhập của công ty.
Yêu cầu
- Phương pháp: ĐĂNG
- URL: https://chatapi.smsbat.com/api/company/get-token
- Tiêu đề: Content-Type: application/json
Thân thể:
Phản hồi
- Mã trạng thái: 200 (OK)
- Nội dung: Mã thông báo chuỗi ("your_token_string")
Lưu ý: Lưu mã thông báo đã nhận cho các yêu cầu tiếp theo.
2. Truy xuất danh sách tổ chức
Gửi yêu cầu GET tới /api/company/ Organisation bằng cách sử dụng mã thông báo công ty để liệt kê các tổ chức của bạn.
Yêu cầu
- Phương pháp: NHẬN
- URL: https://chatapi.smsbat.com/api/company/ Organisation
- Tiêu đề:
- Ủy quyền: Người mang {token}
- Chấp nhận: văn bản/thuần túy
Phản hồi - Mã trạng thái: 200 (OK) - Thân thể:
3. Truy xuất toán tử theo tổ chức
Gửi yêu cầu GET tới /api/operator bằng cách sử dụng tham số organId.
Yêu cầu
- Phương pháp: NHẬN
- URL: https://chatapi.smsbat.com/api/operator? OrganisationId={id}
- Tiêu đề:
- Ủy quyền: Người mang {token}
- Chấp nhận: văn bản/thuần túy
Phản hồi - Mã trạng thái: 200 (OK) - Thân thể:
4. Thêm người vận hành vào hệ thống
Sử dụng mã thông báo của công ty để truy cập điểm cuối này và đồng bộ hóa người vận hành với hệ thống.
Yêu cầu
- Phương pháp: ĐĂNG
- URL: https://chatapi.smsbat.com/api/operator/synchronize
- Tiêu đề:
- Ủy quyền: Người mang {token}
- Loại nội dung: ứng dụng/json
Thân thể:
Phản hồi - Mã trạng thái: 200 (OK) - Thân thể:
Trạng thái người vận hành có thể có:
- Đang hoạt động: 0
- Không hoạt động: 1
- Đã xóa: 2
5. Lấy Token của người vận hành
Ủy quyền bằng mã thông báo của công ty để nhận mã thông báo cho một nhà điều hành cụ thể.
Yêu cầu
- Phương pháp: ĐĂNG
- URL: https://chatapi.smsbat.com/api/operator/get-token
- Tiêu đề:
- Ủy quyền: Người mang {token}
- Loại nội dung: ứng dụng/json
Thân thể:
expiresAt là bắt buộc và xác định thời lượng phiên của người vận hành (tối đa +24 giờ).
Phản hồi - Mã trạng thái: 200 (OK) - Nội dung: Mã thông báo chuỗi
6. Xác thực mã thông báo của người vận hành
Xác minh tính hợp lệ của mã thông báo của nhà điều hành.
Yêu cầu
- Phương pháp: ĐĂNG
- URL: https://chatapi.smsbat.com/api/operator/validate-token
- Tiêu đề:
- Ủy quyền: Người mang {token}
- Loại nội dung: ứng dụng/json
Nội dung: "operator_token_string"
Phản hồi hợp lệ (200 OK):
{
"isValid": true,
"operatorId": 0,
"clientId": 0,
"expiresAt": "2024-12-28T14:04:15.861Z",
"error": null
}
7. Liên kết sâu tới bảng trò chuyện của nhà điều hành
Các hệ thống bên ngoài (CRM, ERP, trang web nội bộ) có thể trực tiếp mở bảng Trò chuyện bằng cách tận dụng các liên kết sâu bằng cách chuyển mã thông báo Người vận hành JWT làm tham số. Nếu mã thông báo không hợp lệ hoặc hết hạn, người dùng sẽ được chuyển hướng đến giao diện đăng nhập.
Định dạng 1: Theo ID trò chuyện
Dạng 2: Theo số điện thoại
Số điện thoại phải ở định dạng quốc tế E.164.Định dạng 3: Theo tên Alpha & Số điện thoại
Định dạng 4: Hoàn thành chi tiết mục tiêu
Chỉ định chính xác nguồn nào sẽ chặn tin nhắn từ:
Nguồn trò chuyện: -0 - Viber
- 1 - ViberBot
- 2 - TelegramBot
- 3 - Whatsapp
- 4 - Tiện ích
- 5 - Rozetka
- 6 - Facebook
- 7 - Instagram