Gởi tin nhắn brandname
Tổng quan
API SMS FPT cho phép bạn triển khai ứng dụng client có thể gửi tin nhắn Brandname đến khách hàng của bạn.
Mô tả
- Chuẩn webservice: RESTFull
- Mô hình cấp phát API: Oauth 2.0
-
Địa chỉ Webservices:
Live: http://app.sms.fpt.net Sandbox: http://sandbox.sms.fpt.net
Sơ đồ hệ thống
Chuẩn bị
Bên đối tác:
- Tên ứng dụng không quá 200 kí tự
- IP Server gọi API RESTFull
- Sau khi được FPT cung cấp account truy cập vào trang quản lý ứng dụng. Bên đối tác tiến hành đăng ký ứng dụng với các thông tin trên để lấy CLIENT_ID và CLIENT_SECRET ở môi trường sandbox
- Bên đối tác sử dụng tài liệu của FPT cung cấp để kết nối đến sandbox
- Sau khi kết nối đến sandbox thành công. Đối tác chuyển sang sử dụng các thông tin ở môi trường live để chạy ứng dụng.
Bên FPT:
- Khi tiến hành kết nối, FPT sẽ cung cấp cho đối tác thông tin tài khoản để đăng ký các thông tin như:
- CLIENT_ID
- CLIENT_SECRET
- Tài liệu:
- Gửi tin nhắn brandname
-
Code ví dụ
- PHP
- ASP.NET
-
SDK
- PHP
- ASP.NET
Thiết lập thư viện
Một số thư viện client được cung cấp trong các ngôn ngữ khác nhau. Các thư viện này sẽ giúp bạn có thể dễ dàng hơn trong việc tương tác với API SMS FPT.
Để sử dụng được API bạn cần phải đăng ký thông tin ứng dụng để nhận CLIENT_ID và CLIENT_SECRET. Để xem hướng dẫn đăng ký, vui lòng click vào đây.
- Trước tiên bạn tải thư viện mới nhất tại http://developer.sms.fpt.net/downloads/php-tech-sdk-lastest.zip sau đó giải nén ra vào project của bạn.
- Thiết lập cấu hình của bạn trong file path/to/TechAPI/bootstrap.php.
- Thêm đoạn code sau trong project của bạn:
- Trước tiên bạn tải thư viện mới nhất tại http://developer.sms.fpt.net/downloads/jsp-tech-sdk-lastest.zip sau đó giải nén và include vào project của bạn.
- Tạo file YourProject/src/java/techsdk.properties với nội dung như sau:
- Trong Servlet hoặc Controller của bạn thiết lập như bên dưới:
- Trước tiên bạn tải thư viện mới nhất tại http://developer.sms.fpt.net/downloads/dot-net-tech-sdk-lastest.zip sau đó giải nén và add reference hai file TechSDK.dll, Newtonsoft.dll vào project của bạn.
- Tạo file Config.cs trong thư mục App_Code (file Config.cs đặt thuộc tính Build Action là compile) của bạn với nội dung như sau:
Gọi API gửi tin nhắn Brandname OTP
- Tin nhắn OTP là loại tin nhắn chăm sóc khách hàng. Tin nhắn sẽ được gửi đến khách hàng ngay lập tức.
- Scope yêu cầu: send_brandname_otp.
- Bạn có thể tham khảo source mẫu tại: http://developer.sms.fpt.net/downloads/sms_brandname_demo_php.zip
- Trong bộ API SMS FPT có sử dụng thư viện JSON, nên bạn cần phải import thư viện JSON vào project của bạn. Nếu như chưa có, bạn có thể tải thư viện JSON về tại đây
- Bạn có thể tham khảo source mẫu tại: http://developer.sms.fpt.net/downloads/jsp_client_demo.zip
- Lưu ý: Source tham khảo sử dụng mô hình Spring Web MVC Framework, và kết nối cơ sở dữ liệu MySQL bằng thư viện JDBC MySQL
- Trong WebForm bạn xử lý như sau:
- Bạn có thể tham khảo source mẫu tại: http://developer.sms.fpt.net/downloads/dot-net-client-demo.zip
Tham số đầu vào
| Tên tham số | Kiểu dữ liệu | Bắc buộc | Mô tả |
|---|---|---|---|
| BrandName | String | Tên dịch vụ BrandName đã đăng ký với FPT. | |
| Phone | String | Số điện thoại của người nhận tin nhắn, chỉ được gửi 01 lần 01 số điện thoại. VD: 0943533xxx, 01234010xxx, 84943533xxx hoặc 841234010xxx |
|
| Message | String | Nội dung của tin nhắn. Phải được mã hóa base64, nếu sử dụng thư viện của FPT cung cấp thì nội dung sẽ được tự động mã hóa. |
Dữ liệu trả về
| Tên tham số | Kiểu dữ liệu | Mô tả |
|---|---|---|
| MessageId | Int | Id của tin brandname gửi đi. |
| BrandName | String | Tên Brandname. |
| Phone | String | Số điện thoại nhận tin nhắn. |
| Telco | String | Nhà mạng. |
| Message | String | Nội dung tin nhắn. |
| PartnerId | String | Mã đối tác. |
Gọi API gửi tin nhắn Brandname quảng cáo
- Tin nhắn quảng cáo là loại tin nhắn không được gửi đến khách hàng ngay lập tức. Tin nhắn sẽ được gửi theo khung giờ của nhà mạng quy định.
- Scope yêu cầu: send_brandname.
- Xem thêm tại: http://developer.sms.fpt.net/downloads/tai-lieu-tich-hop-brandname.pdf
Bảng mã lỗi
| Mã lỗi | Mô tả |
|---|---|
| Lỗi phản hồi từ server | |
| 1001 | Request không hợp lệ. |
| 1002 | Client không được cấp phép truy cập. |
| 1003 | Truy cập bị từ chối. |
| 1004 | Loại response yêu cầu không được hỗ trợ. |
| 1005 | Lỗi server. |
| 1006 | Server tạm thời không thể xử lý request từ client. |
| 1007 | Thông tin client không đúng. |
| 1008 | Loại hình cấp quyền không hợp lệ. |
| 1009 | Các scope không hợp lệ |
| 1010 | Scope không đủ để truy cập API |
| 1011 | Access token không hợp lệ |
| 1012 | Access token đã bị thay đổi |
| 1013 | Access token hết hạn |
| 1014 | Các tham số truyền vào bị lỗi |
| Lỗi xảy ra ở client | |
| 2001 | CLIENT_ID bắt buộc và không được trống. |
| 2002 | CLIENT_SECRET bắt buộc và không được trống. |
| 2003 | Access token hết hạn. |
| 2004 | Thời gian kết nối bị quá hạn. |
Tài liệu chi tiết
Tài liệu mô tả chi tiết API gửi tin nhắn brandname:
- https://developer.sms.fpt.net/downloads/tai-lieu-tich-hop-brandname.pdf
Tài liệu mô tả chi tiết API gửi tin nhắn brandname (API Connection Manual SMS Brandname - English):
- https://developer.sms.fpt.net/downloads/tai-lieu-tich-hop-brandname-en.pdf