Từ khóa thường tìm kiếm: mâtpopuptcrmfamilytcall
View Categories

API Message Gateway

Menu

Chương I – Tổng quan

1. Thông tin kết nối

    • Link Product (domain): Tas Cung cấp
    • User: Tas Cung cấp
    • Pass: Tas Cung cấp

Lưu ý: Để được hỗ trợ thông tin chi tiết, vui lòng gửi yêu cầu đến địa chỉ email: support@trianh.vn

2. Quy trình xử lý

a.  Sơ đồ và quy trình gửi tin

    • Sơ đồ

    • Quy trình gửi tin

b. Hướng dẫn lấy TOKEN xác thực

Để kết nối và sử dụng các dịch vụ web thông qua API, cần phải có thông tin Token làm cơ sở chứng thực quyền truy cập hệ thống.

    • EndPoint: https://domain/apiv1/auth
    • Phương thức: GET
    • Data header:

Ví dụ:

Bước 1: Chọn GET.

Bước 2: Nhập địa chỉ URL: https://domain /apiv1/auth/

Bước 3: Chọn tab Authorization

Bước 4: Chọn Basic Auth

Bước 5: Nhập Username, Password

Bước 6: Bấm Send

Bước 7: Lưu thông tin access_token trả về

Chương II – API web service

1. API gửi tin Message gateway

Mục đích: Tối ưu chi phí gửi tin nhắn thông qua các kênh khác nhau trong cùng một tiến trình.

    • Token: Được lấy ở Chương I mục 2.2
    • EndPoint: https://domain/apisupport/send/

Lưu ý: Để trống thuộc tính send_type = “”

    • Data post

Ví dụ:

Request

Lưu ý: Để gửi nhiều số cùng lúc thì thêm số điện thoại và cách nhau bằng dấu phẩy

Ví dụ: “to” : “091XXX0401,096XXX0601,093XXX1234”

Kết quả thực hiện gởi tin gateway và trả về kết quả (cấu trúc trả về định dạng json)

Ở ví dụ này send_type đang để trống nên gửi theo thứ tự ưu tiên của hệ thống

Response

2. API Gửi tin SMS

Mục đích: Dùng để tích hợp hệ thống cho việc gửi tin là loại SMS (Short Message Services – dịch vụ nhắn tin ngắn)

Thực hiện các thao tác như mục 1

    • Token: Được lấy ở Chương I mục 2.2
    • EndPoint: https://domain/apisupport/send/

Lưu ý: Set thuộc tính send_type = “SMS”

Ví dụ:

Request

Response

3. API Gửi tin ZNS

Mục đích: Dùng để tích hợp Hệ thống cho việc gửi tin là loại ZNS (Zalo Notification Service – là dịch vụ gửi thông báo chăm sóc khách hàng trên Zalo)

Thực hiện các thao tác như mục 1

      • Token: Được lấy ở Chương I mục 2.b
      • EndPoint: https://domain/apisupport/send/

Lưu ý: Set thuộc tính send_type = “ZNS”

Ví dụ:

Request

Response

Chương III – API Get back

1. API Get back SMS

Mục đích: Sử dụng API get back này để lấy trạng thái cuối cùng từ Nhà mạng (Telco) trả về

    • Token: Được lấy ở Chương I mục 2.b
    • URL: https://domain/apisupport/get-back
    • Data post:

Ví dụ

Request

Response

2. API Get back ZNS

Mục đích: Sử dụng API get back này để lấy trạng thái cuối cùng từ Zalo trả về

    • Token: Được lấy ở Chương I mục 2.b
    • URL: https://domain/apisupport/get-back/zns
    • Data post:

Ví dụ:

Request

Response

3. Danh sách mã kết quả trả về khi gửi tin

‘000’ => ‘Không lỗi’, //”NoError”,

‘001’ => ‘Có lỗi giá trị không phù hợp với kiểu dữ liệu mô tả’, //”InputNotValid”,

‘100’ => ‘Token không hợp lệ’, //”TokenNotValid”,

‘101’ => ‘Tài khoản bị khóa’, //”UserIsLock”,

‘102’ => ‘Tài khoản không đúng’, //”UserNotValid”,

‘218’ => ‘Tài khoản Zalo không tồn tại hoặc đã bị vô hiệu hoá’, //“Zalo account not existed ”

‘304′ => ‘Tin bị lặp trong 5 phút’, //”DuplicateMessage”,

‘904’ => ‘Brandname không hợp lệ’, //”BrandnameNotValid”,

‘002’ => ‘Loại tin không hợp lệ’, //”MessageTypeNotValid”,

‘003’ => ‘Loại tin không được phép gửi’, //”MessageTypeNotAllow”,

‘005’ => ‘Số điện thoại nhận không hợp lệ’, //”ReceiverNotValid”,

‘006’ => ‘Mã nhà mạng không hợp lệ’, //”TelcoNotValid”,

‘007’ => ‘Nội dung chứa từ bị khóa’, //”ContentContainsBlockedWord”,

‘008’ => ‘Nội dung chứa ký tự unicode’, //”ContentContainsUnicode”,

‘009’ => ‘Nội dung có ký tự không hợp lệ’, //”ContentNotValidateGsm0338″,

‘010’ => ‘Độ dài nội dung không hợp lệ’, //”LengthOfContentNotValid”,

‘011’ => ‘Nội dung không khớp với mẫu khai’, //”NotMatchTemplate”,

‘012’ => ‘Tài khoản không được phân gửi tới nhà mạng’, //”TelcoNotAllow”,

‘013’ => ‘Số điện thoại nhận trong danh sách cấm gửi’, //”MsisdnInBlacklist”,

‘014’ => ‘Tài khoản không đủ tiền để chi trả’, //”AccountNotEnoughToPay”,

‘015’ => ‘Tài khoảng không đủ tin để gửi’, //”AccountNotEnoughQuota”,

‘016’ => ‘Thời gian gửi tin không hợp lệ’, //”ScheduledNotValid”,

‘017’ => ‘Mã order không hợp lệ’, //”OrderCodeNotValid”,

‘018’ => ‘Mã gói không hợp lệ’, //”PackageCodeNotValid”,

‘019’ => ‘Số điện thoại không hợp lệ’, //”MsisdnNotValid”,

‘020’ => ‘Số điện thoại không trong danh sách nhà mạng được lọc’, //”TelcoFilter”,

‘021’ => ‘Số điện thoại không trong danh sách nhà mạng được lọc’, //”BlockingTimeAdv”,

‘022’ => ‘Định dạnh nội dung không hợp lệ’, //”FormatOfContentNotValid”,

‘025’ => ‘Nội dung không thể chuyển Unicode’, //”CantConvertToNotUnicode”,

‘801’ => ‘Mẫu tin chưa được thiết lập’, //”TemplateNotSet”,

‘802’ => ‘Tài khoản chưa được thiết lập profile’, //”AccountNotSetProfile”,

‘803’ => ‘Tài khoản chưa được thiết lập giá’, //”AccountNotSetPrice”,

‘804’ => ‘Đường gửi tin chưa được thiết lập’, //”RouterNotAvaiable”,

‘805’ => ‘Đường gửi tin không hỗ trợ unicode’, //”RouterNotSuportUnicode”,

‘999’ => ‘Lỗi khác trên hệ thống’, //”ErrorOnServer”