TÀI LIỆU HƯỚNG DẪN SỬ DỤNG API HỆ THỐNG SMS BRANDNAME

1.     Danh mục API

1.1.          Lấy token để được quyền vào hệ thống

Địa chỉ kết nối API: http://mysmsbrandname.com/api/auth

Phương thức: POST

1.2.          Gửi tin nhắn qua server BMS tech

Địa chỉ kết nối API: http://mysmsbrandname.com/api/send_sms

Phương thức: POST

 

2.     Cách kết nối API

2.1.          Lấy token để được quyền vào hệ thống

Giá trị truyền vào

Ý nghĩa

username

Tên đăng nhập vào hệ thống server BMS Tech tại đại chỉ : http://mysmsbrandname.com/web/login

password

Mật khẩu đăng nhập vào hệ thống server BMS Tech tại đại chỉ : http://mysmsbrandname.com/web/login

 

2.2.          Gửi tin nhắn qua server BMS tech

Giá trị truyền vào

Ý nghĩa

token

Token quyền truy cập hệ thống lấy được ở mục 1.1

title

Tiêu đề tin nhắn (Lưu trong hệ thống, người nhận không nhìn thấy tiêu đề này)

brandname

Brandname gửi tin nhắn. Brandname cần đăng ký trước với BMS Tech

accent

Gửi tin nhắn có dấu hoặc không dấu. Chỉ nhận giá trị “True” hoặc “False”

content

Nội dung tin nhắn. Người nhận sẽ nhìn thấy nội dung này

phone

Danh sách số điện thoại người nhận. Số điện thoại bắt đầu bằng mã nước VN là 84xxxxxxxx và ngăn cách nhau bằng dấu phẩy “,”. Ví dụ: 84987654321, 841664567891

 

 

 

3.     Kết quả trả về

3.1.          Lấy token để được quyền vào hệ thống

Giá trị trả về

Ý nghĩa

"Wrong username or password"

Sai tên đăng nhập hoặc mật khẩu

"token":"dãy chữ số”

"name": "BMS TECHNOLOGY”

token: Mã token để truy cập hệ thống. Không để lộ mã này cho bên thứ 3.

name: Tên công ty hay khách hàng đăng ký trên hệ thống BMS Tech

 

3.2.          Gửi tin nhắn qua server BMS tech

Giá trị trả về

Ý nghĩa

‘No company found’ hoặc 'No user found’

Không tìm thấy công ty của bạn, hãy lấy mã token mới và thử lại

'Your company has no brandname with name: ABC’

Công ty của bạn chưa đăng ký brandname ABC

‘Your balance not enough to send SMS’

Tài khoản của bạn không đủ để gửi tin nhắn

'Send message success.'

Gửi tin nhắn thành công

'Send message fail'

Gửi tin nhắn thất bại

'Input parameters are not enough'

Bạn chưa truyền vào đủ tham số như mục 2.2

KẾT NỐI QUA XMLRPC

Phù hợp với các APP viết bằng Python, PHP, Ruby on Rail

Đối với python 2.x

# -*- coding: utf-8 -*-
import xmlrpclib

url = 'http://mysmsbrandname.com'
db = 'sms_bms'
username = 'cs'
password = '1'

common = xmlrpclib.ServerProxy('{}/xmlrpc/2/common'.format(url))
models = xmlrpclib.ServerProxy('{}/xmlrpc/2/object'.format(url))
uid = common.authenticate(db, username, password, {})

# Data input
title = 'xmlrpc'
brandname = 'SoLienLacDT'
accent = 'False'
content = 'send from xmlrpc'
phone = '84968590836'

# Call via xmlrpc
send = models.execute_kw(db, uid, password, 'bms.send_sms_xmlrpc', 'create', [
    {'title': title,
     'brandname': brandname,
     'accent': accent,
     'content': content,
     'phone': phone}])


Đối với python 3.x

# -*- coding: utf-8 -*-
import xmlrpc.client

url = 'http://mysmsbrandname.com'
db = 'sms_bms'
username = 'cs'
password = '1'

common = xmlrpc.client.ServerProxy('{}/xmlrpc/2/common'.format(url))
models = xmlrpc.client.ServerProxy('{}/xmlrpc/2/object'.format(url))
uid = common.authenticate(db, username, password, {})

# Data input
title = 'xmlrpc'
brandname = 'SoLienLacDT'
accent = 'False'
content = 'send from xmlrpc'
phone = '84968590836'

# Call via xmlrpc
send = models.execute_kw(db, uid, password, 'bms.send_sms_xmlrpc', 'create', [
    {'title': title,
     'brandname': brandname,
     'accent': accent,
     'content': content,
     'phone': phone}])

Hotline hỗ trợ kỹ thuật:

09635.23434

skype: cs@bmstech.io