Lập trình tích hợp gửi SMS

LẬP TRÌNH TÍCH HỢP GỬI SMS

Nếu Website, hệ thống của bạn đang cần tính năng gửi SMS đến điện thoại chẳng hạn như nhắn mã xác nhận khi đăng ký Website, hay phần mêm quản lý nhân sự cần nhắn tin thông báo lịch họp, chúc mừng sinh nhật nhân viên … Hệ thống SMS API của eSMS sẽ đáp ứng được hoàn toàn các yêu cầu của bạn.

Hệ thống API của chúng tôi đảm bảo tính nhanh, đơn giản, tin cậy và dễ dàng tích hợp vào bất kỳ hệ thống nào.

Có thể kết nối bằng tất cả cả các ngôn ngữ lập trình như C#, Java, ASP.NET, PHP.

Cơ chế hoạt động Hệ thống SMS API của eSMS

  • Kết nối thông qua Webservice: POST/Get,SOAP, Restful
  • Xác thực: các request của bạn sẽ được hệ thống xác thực thông qua APIkey và SecretKey, 2 key này sẽ được cấp sau khi bạn đăng ký tài khoản tại eSMS.vn

 

Trước khi sử dụng eSMS API vui lòng đăng ký tài khoản. (Có ngay 5000 đ trong tài khoản để dùng thử)

Sau khi đăng ký xong bạn truy cập vào Menu Quản lý API để lấy key

he thong sms api esms

 

Lưu ý: phần này dành cho các lập trình viên, các đơn vị có bộ phận IT. Nếu bạn không có bộ phận IT và muốn chúng tôi hỗ trợ tích hợp liên hệ với chúng tôi qua số Hotline: 0901.888.484; Skype: thaihabk05

 

Xem bài hướng dẫn chi tiết và tải code mẫu tại đây:

esms.vn/blog/3-buoc-de-co-the-gui-tin-nhan-tu-website-ung-dung-cua-ban-bang-sms-api-cua-esmsvn

Download tài liệu API dưới dạng PDF: http://esms.vn/eSMS.vn_TailieuAPI.pdf

Kết nối thông qua SOAP

Hướng dẫn cách sử dụng API thông qua SOAP

Lấy đường dẫn WSDL tại địa chỉ:  http://api.esms.vn/MainService.svc?wsdl

Add vào Service Reference với Namespace tùy ý . Sau đó config Service như sau

 "f26fd24d-a345-4a66-8629-88bdd0fdee78.png"

Bấm OK .

Dưới client sẽ khai báo client như sau:

 "de842c15-9283-4c6d-aa37-bd4df5f155d8.png"

 

Từ đây sẽ gọi các hàm API cung cấp để sử dụng .

SMS API - Gửi SMS bằng HTTP GET

Hàm gửi SMS bằng cách gọi HTTP Get 

Đơn giản bạn chỉ cần Submit 1 Request HTTP Get theo URL sau:

http://rest.esms.vn/MainService.svc/json

/SendMultipleMessage_V4_get?Phone={Phone}&Content={Content}&ApiKey={ApiKey}&SecretKey={SecretKey}&IsUnicode={IsUnicode}&Brandname={Brandname}&SmsType={SmsType}


 

Request mẫu: 

http://rest.esms.vn/MainService.svc/json

/SendMultipleMessage_V4_get?Phone=09xxxx&Content=DemoeSMS&ApiKey=xxxx&SecretKey=xxxx&SmsType=x

Bạn chỉ cần thay các thông tin bôi vàng ở trên bằng thông tin của bạn để gửi tin nhắn

 

Tham số
     Ý nghĩa
PHONE

     Số điện thoại cần gửi 

CONTENT     Nội dung tin nhắn
APIKEY     APIKey được cấp với tài khoản đăng ký trên esms.vn 
SecretKey     SecretKey được cấp với tài khoản đăng ký trên esms.vn 
SMSTYPE      Loại tin nhắn:
      2: Tin hiển thị thương hiệu(Brandname) chăm sóc khách hàng. Tin đi ngay. Phải đăng ký Brandname trước mới gửi được
      8: Đầu số cố định 10 số, giá tốt, tuy nhiên cần phải đăng ký Template trước với chúng tôi
Để đăng ký Brandname vui lòng liên hệ bộ phận kinh doanh: 0901.888.484

Một số mẫu template nếu muốn gửi OTP:
- Mã {P}
- Ma OTP cua ban la {P}

- Ma Xac Nhan cua ban la {P}

 

 

Server sẽ trả về định dạng JSON như bên dưới

{  "CodeResult": "100",   “CountRegenerate”:”0”,  "SMSID": "24342680"

}

 

Thông tin kết quả:
TrườngÝ nghĩa
SMSID

ID của tin nhắn lưu trên hệ thống esms.vn, quý khách lưu lại để có thể truy xuất các thông tin chi tiết về trạng thái SMS về sau

CodeResultMã kết quả của request
ErrorMessageChi tiêt lỗi nếu có

 

Bảng CodeResponse

Ý nghĩa

100:

Request thành công

99

Lỗi không xác định , thử lại sau

101

Đăng nhập thất bại (api key hoặc secrect key không đúng )

102

Tài khoản đã bị khóa

103

Số dư tài khoản không đủ dể gửi tin

104

Mã Brandname không đúng

 

 

Lưu ý: phần này dành cho các lập trình viên, các đơn vị có bộ phận IT. Nếu bạn không có bộ phận IT và muốn chúng tôi hỗ trợ tích hợp liên hệ với chúng tôi qua số Hotline: 0901.888.484; Skype: thaihabk05

 

Xem bài hướng dẫn chi tiết và tải code mẫu tại đây:

esms.vn/blog/3-buoc-de-co-the-gui-tin-nhan-tu-website-ung-dung-cua-ban-bang-sms-api-cua-esmsvn

Download tài liệu API dưới dạng PDF: http://esms.vn/eSMS.vn_TailieuAPI.pdf

API lấy số dư

Theo giao thức GET

Url Request có dạng

http://rest.esms.vn/MainService.svc/{ResponseType}/GetBalance/{ApiKey}/{SecretKey}

Request mẫu

http://rest.esms.vn/MainService.svc/xml/GetBalance/123456789/987654321

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ cả json và xml
APIKey Thông tin APIKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
SecretKey Thông tin SecretKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập

Response trả về có dạng:

{
  "Balance": 7527430,
  "CodeResponse": "100",
  "UserID": 0001
}

Thông tin trả về

Trường Ý nghĩa
Balance Tổng số dư trong tài khoản
CodeResponse Kết quả của request
UserID Mã người dùng

ý nghĩa CodeResponse

Ý nghĩa
100 Request thành công
99 Lỗi không xác định , thử lại sau
101 Đăng nhập thất bại (api key hoặc secrect key không đúng)
102 Tài khoản đã bị khóa
103 Số dư tài khoản không đủ dể gửi tin
104 Mã Brandname không đúng

API gửi tin nhắn

Theo giao thức GET

Url Request có dạng

http://rest.esms.vn/MainService.svc/{ResponseType}/SendMultipleMessage_V4_get?Phone={Phone}&Content={Content}&ApiKey={ApiKey}&SecretKey={SecretKey}&IsUnicode={IsUnicode}&Brandname={Brandname}&SmsType={SmsType}&CallBackUrl={CallBackUrl}

Request mẫu

http://rest.esms.vn/MainService.svc/json/SendMultipleMessage_V4_get?Phone=09xxxx&Content=DemoText&ApiKey=xxxx&SecretKey=xxxx&SmsType=2&Brandname=Test

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng XML và JSON
Phone Số điện thoại người nhận
Content Nội dung gửi đến người nhận
ApiKey Thông tin APIKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
SecretKey Thông tin SecretKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
SmsType Là loại tin nhắn muốn sử dụng, mỗi loại sẽ có đầu số hiển thị khác nhau và chi phí khác nhau.Vui long liên hệ hotline 0901.888.484 để được tư vấn cụ thể hơn
Giá trị Ý nghĩa
2 Brandname chăm sóc khách hang Khuyến khích sử dụng loại tin nhắn này. Bạn cần liên hệ nhân viên kinh Doanh hoặc hotline 0901.888.484 để đăng ký Brandname riêng của mình và Brandname test
8 Tin nhắn đầu số cố định 10 số, chuyên dùng cho chăm sóc khách hang. Bạn cần phải đăng ký mẫu tin nhắn trước với bộ phận kinh doanh để đăng ký và sử dụng.
Brandname Tên Brandname (tên công ty hay tổ chức khi gửi tin sẽ hiển thị trên tin nhắn đó). Không (Có khi gửi brandname.)
Sandbox
Ý nghĩa
0 Không thử nghiệm, gửi tin đi thật
1 Thử nghiệm (tin không đi mà chỉ tạo ra tin nhắn)
Không
RequestId ID Tin nhắn của đối tác, dùng để kiểm tra ID này đã được hệ thống esms tiếp nhận trước đó hay chưa.Ví dụ: requestid=123456 Không
SendDate Đặt lịch gửi tin Không
CallBackUrl Đặt lịch gửi tin Không

Response trả về có dạng:

{
    "CodeResult": "100",
    “CountRegenerate”:”0”,
    "SMSID": "24342680"
}

Thông tin trả về

Trường Ý nghĩa
SMSID ID của tin nhắn mới được tạo ra trên hệ thống eSMS. Dùng ID này để query lấy trạng thai tin nhắn.

ý nghĩa CodeResponse

Ý nghĩa
100 Request đã được nhận và xử lý thành công.
104 Brandname không tồn tại hoặc đã bị hủy
118 Loại tin nhắn không hợp lệ
119 Brandname quảng cáo phải gửi ít nhất 20 số điện thoại
131 Tin nhắn brandname quảng cáo độ dài tối đa 422 kí tự
132 Không có quyền gửi tin nhắn đầu số cố định 8755
99 Lỗi không xác định
177 Brandname không có hướng ( Viettel - The Network Viettel have not registry.<br>VinaPhone - The Network VinaPhone have not registry.<br>Mobifone - The Network Mobifone have not registry.<br>Gtel - The Network Gtel have not registry.<br>Vietnammobile - The Network Vietnammoile have not registry.)
159 RequestId quá 120 ký tự
145 Sai template mạng xã hội

Theo giao thức POST

Url Request có dạng

http://rest.esms.vn/MainService.svc/json/SendMultipleMessage_V4_post_json/

Request mẫu

Các bạn cần gọi lệnh POST đến URL ở trên với data POST lên có dạng như sau :
{"ApiKey":"xxxxx","Content":"xxxxx","Phone":"xxxx","SecretKey":"xxxxx","IsUnicode":"x","Brandname":"xxxx","SmsType":"x"}

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng XML và JSON
Phone Số điện thoại người nhận
Content Nội dung gửi đến người nhận
ApiKey Thông tin APIKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
SecretKey Thông tin SecretKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
SmsType Là loại tin nhắn muốn sử dụng, mỗi loại sẽ có đầu số hiển thị khác nhau và chi phí khác nhau.Vui long liên hệ hotline 0901.888.484 để được tư vấn cụ thể hơn
Giá trị Ý nghĩa
2 Brandname chăm sóc khách hang Khuyến khích sử dụng loại tin nhắn này. Bạn cần liên hệ nhân viên kinh Doanh hoặc hotline 0901.888.484 để đăng ký Brandname riêng của mình và Brandname test
8 Tin nhắn đầu số cố định 10 số, chuyên dùng cho chăm sóc khách hang. Bạn cần phải đăng ký mẫu tin nhắn trước với bộ phận kinh doanh để đăng ký và sử dụng.
Brandname Tên Brandname (tên công ty hay tổ chức khi gửi tin sẽ hiển thị trên tin nhắn đó). Không (Có khi gửi brandname.)
Sandbox
Ý nghĩa
0 Không thử nghiệm, gửi tin đi thật
1 Thử nghiệm (tin không đi mà chỉ tạo ra tin nhắn)
Không
RequestId ID Tin nhắn của đối tác, dùng để kiểm tra ID này đã được hệ thống esms tiếp nhận trước đó hay chưa.Ví dụ: requestid=123456 Không
SendDate Đặt lịch gửi tin Không
CallBackUrl Đặt lịch gửi tin Không

Response trả về có dạng:

{
    "CodeResult": "100",
    “CountRegenerate”:”0”,
    "SMSID": "24342680"
}

Thông tin trả về

Trường Ý nghĩa
SMSID ID của tin nhắn mới được tạo ra trên hệ thống eSMS. Dùng ID này để query lấy trạng thai tin nhắn.

ý nghĩa CodeResponse

Ý nghĩa
100 Request đã được nhận và xử lý thành công.
104 Brandname không tồn tại hoặc đã bị hủy
118 Loại tin nhắn không hợp lệ
119 Brandname quảng cáo phải gửi ít nhất 20 số điện thoại
131 Tin nhắn brandname quảng cáo độ dài tối đa 422 kí tự
132 Không có quyền gửi tin nhắn đầu số cố định 8755
99 Lỗi không xác định
177 Brandname không có hướng ( Viettel - The Network Viettel have not registry.<br>VinaPhone - The Network VinaPhone have not registry.<br>Mobifone - The Network Mobifone have not registry.<br>Gtel - The Network Gtel have not registry.<br>Vietnammobile - The Network Vietnammoile have not registry.)
159 RequestId quá 120 ký tự
145 Sai template mạng xã hội

API kiểm tra trạng thái tin nhắn

Theo giao thức GET

Url Request có dạng

http://rest.esms.vn/MainService.svc/{ResponseType}/GetSendStatus?RefId=XXX&ApiKey=XXX&SecretKey=XX_XX
https://restapi.esms.vn/MainService.svc/{ResponseType}/GetSendStatus?RefId=XXX&ApiKey=XXX&SecretKey=XXXX

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng JSON và XML
Apikey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Secretkey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
SmsId ID của SMS được trả về sau khi gọi các lệnh gửi tin.

Response trả về có dạng:

{
   "CodeResponse": "100",
   "SMSID": "24312210",
   SendFailed": 0,
   SendStatus": 5,
   SendSuccess": 1,
   TotalReceiver": 1,
   TotalSent": 1
}

Thông tin trả về

Trường Ý nghĩa
SMSID Mã tin nhắn, được trả về sau khi gọi API gửi tin
SendStatus
Ý nghĩa
1 Đang chờ duyệt
2 Đang chờ gửi
3 Đang gửi
4 Bị từ chối
5 Đã gửi xong
6 Đã bị xóa
TotalSent Tổng số tin nhắn cần gửi
TotalReceiver Tổng số người nhận
SentSuccess Tổng số tin nhắn gửi thành công
SentFailed Tổng số tin nhắn gửi thất bại

API kiểm tra chi tiết từng số trong tin nhắn

Theo giao thức GET

Url Request có dạng

Hàm lấy danh sách số điện thoại của một tin nhắn đã gửi (dựa trên SmsID hệ thống trả về) kèm theo trạng thái gửi (Số điện thoại đó đã gửi thành công chưa?)
http://rest.esms.vn/MainService.svc/{ResponseType}/GetSmsReceiverStatus_get?&ApiKey=XXXX&SecretKey=XXXX&RefId=XXXX

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng JSON và XML
Apikey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Secretkey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
ReftId ID của SMS được trả về sau khi gọi các lệnh gửi tin.

Response trả về có dạng:

{
    "CodeResult": "100",
    ReceiverList": [
      {
      "IsSent": true,
      "Phone": "XXXX",
      "SentResult": true
      }
    
}

ý nghĩa CodeResponse

Ý nghĩa
105 Id không tồn tại trong hệ thống.

API lấy danh sách tin nhắn theo khoảng thời gian

Theo giao thức POST

Url Request có dạng

http://rest.esms.vn/MainService.svc/{ResponseType}/GetSmsSentData

Request mẫu

Các bạn cần gọi lệnh POST đến URL ở trên với data POST lên có dạng như sau:

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng JSON và XML
Apikey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Secretkey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
From Thời gian bắt đầu (Định dạng: MM/dd/YYYY)
To Thời gian kết thúc (Định dạng: MM/dd/YYYY)

Thông tin trả về

Trường Ý nghĩa
SentTime Thời gian gửi
SmsId Id cảu tin nhắn
Phone Số điện thoại
Content Nội dung
SmsType Loại tin nhắn
SentStatus Trạng thái gửi
CodeResult Mã kết quả của request
ErrorMessage Chi tiêt lỗi nếu có

ý nghĩa CodeResponse

Ý nghĩa
140 Thời gian không hợp lệ

API lấy danh sách brandname

Theo giao thức GET

Url Request có dạng

http://rest.esms.vn/MainService.svc/{ResponseType}/GetListBrandname/{ApiKey}/{SecretKey}

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng JSON và XML
Apikey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Secretkey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)

Response trả về có dạng:

{
  "CodeResponse": "100",
  "ListBrandName": [
  {
    "Brandname": "Test_Sang",
    "Type": 2
  },
  {
    "Brandname": "sangbrand",
    "Type": 2
  }
  ]
}

Thông tin trả về

Trường Ý nghĩa
Brandname Brandname đăng ký
Type
Ý nghĩa
1Quảng cáo
2Chăm sóc khách hàng

ý nghĩa CodeResponse

Ý nghĩa
101 Sai Api or Secretkey

API lấy trạng thái cuộc gọi

Theo giao thức GET

Url Request có dạng

http://voiceapi.esms.vn/MainService.svc/{ResponseType}/GetSendStatus?ReferenceId={ReferenceId}&ApiKey={ApiKey}&SecretKey={SecretKey}

Request mẫu

http://voiceapi.esms.vn/MainService.svc/xml/GetSendStatus?ApiKey=xxxx&SecretKey=xxxx&ReferenceId=xxxx

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ cả json và xml
ReferenceId Id cuộc gọi trả về sau khi gọi request tạo cuộc gọi
APIKey Thông tin APIKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
SecretKey Thông tin SecretKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập

Response trả về có dạng:

{
  "CodeResponse": "100",
  "callduration": 24,
  "callstatus": "ANSWERED",
  "ivr": "2"
}

Thông tin trả về

Trường Ý nghĩa
CodeResponse Kết quả của Request
Giá trịÝ nghĩa
100Request hợp lệ.
105Không tìm thấy cuộc gọi
101Sai ApiKey hoặc SecretKey
CallStatus Kết quả của cuộc gọi (ANSWERED: cuộc gọi được trả lời, NOANSWERED: cuộc gọi thất bại hoặc không ai bắt máy)
CallDuration Số giây cuộc gọi thực hiện
Ivr Phím phản hồi của người nghe

API tạo cuộc gọi tự động theo Template

Theo giao thức GET

Hàm cho phép bạn gửi tin nhắn thoại đến 1 số điện thoại bởi mẫu cuộc gọi đã được tạo sẵn trên hệ thống.

Url Request có dạng

http://voiceapi.esms.vn/MainService.svc/{ResponseType}/MakeCallTemplate_V2?ApiKey={ApiKey}&SecretKey={SecretKey}&TemplateId={TemplateId}&Phone={Phone}&VariableListStr={VariableListStr}&SendDate={SendDate}&Voice={Voice}&Speed={Speed}&CallbackUrl={CallbackUrl}

Request mẫu

http://voiceapi.esms.vn/MainService.svc/xml/MakeCallTemplate_V2?ApiKey=xxxx&SecretKey=xxxx&TemplateId=xxxx&Phone=xxxx&VariableListStr=xxxx

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng XML và JSON
Phone Số điện thoại người nhận
TemplateId Id mẫu cuộc gọi đăng ký trên trang account.esms.vn
ApiKey Thông tin APIKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
SecretKey Thông tin SecretKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
VariableListStr Chuỗi biến chứa danh sách giá trị các biến của mẫu cuộc gọi, cách nhau bởi dấu “||”, thứ tự các biến từ trái sang phải.
Ví dụ: Trung||20000 (Giá trị biến 1: Trung, Giá trị biến 2: 20000)
Có (Có khi mẫu cuộc gọi có biến)
SendDate Đặt lịch gửi tin (định dạng: yyyy/MM/dd hh:mm:ss)Ví dụ: 2017/12/12 14:00:00 Không
Voice Giọng đọc biến, có các giá trị sau đây:
+ male: giọng nam miền Bắc
+ female: giọng nữ miền Bắc
+ hatieumai: giọng nữ miền Nam
+ ngoclam: giọng nữ Huế
Không
Speed Tốc độ đọc biến, có các giá trị sau đây:
+ -3: rất chậm
+ -2: khá chậm
+ -1: chậm
+ 0: bình thường
+ 1: nhanh
+ 2: khá nhanh
+ 3: rất nhanh
Không

Response trả về có dạng:

{
"CodeResult": "100",
"SMSID": "8eb2af6d-fb4c-4814-b9cc-4c0e3ed32edf "
}

Thông tin trả về

Trường Ý nghĩa
SMSID ID của tin nhắn thoại mới được tạo ra trên hệ thống eSMS. Dùng ID này để query lấy trạng thái tin nhắn thoại.
CodeResult
Giá trịÝ nghĩa
100Request đã được nhận và xử lý thành công.
104Danh sách biến của mẫu tin không hợp lệ
105Danh sách biến của mẫu tin không hợp lệ
102Chưa có bảng giá
103103 Số dư tài khoản không đủ
99Lỗi không xác định

API tạo cuộc gọi tự động từ file ghi âm

Theo giao thức GET

Url Request có dạng

http://voiceapi.esms.vn/MainService.svc/{ResponseType}MakeCallRecord_V2?ApiKey={ApiKey}&SecretKey={SecretKey}&TemplateId={RecordId}&Phone={Phone}&SendDate={SendDate}&NumberForward={NumberForward}&MaxRepeat={MaxRepeat}&MaxRetry={MaxRetry}&Ivr={Ivr}&TimeWaitToIvr={TimeWaitToIvr}&WaitRetry={WaitRetry}&CallbackUrl={CallbackUrl}

Request mẫu

http://voiceapi.esms.vn/MainService.svc/xml/MakeCallRecord_V2?ApiKey=xxxx&SecretKey=xxxx&TemplateId=xxxx&Phone=xxxx&SendDate=2017/12/12 14:00:00

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng JSON và XML
Apikey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Secretkey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Phone Số điện thoại người nhận
TemplateId Id file ghi âm tạo trên trang account.esms.vn
NumberForward Số điện thoại được chuyển đến khi nhập đúng Ivr Không
SendDate Đặt lịch gửi tin (định dạng: yyyy/MM/dd hh:mm:ss)Ví dụ: 2017/12/12 14:00:00 Không
MaxRepeat Số lần lặp lại file ghi âm khi nghe Không
MaxRetry Số lần gọi lại khi người nhận không bắt máy Không
Ivr Phím quy định khi người nhận bấm để chuyển số (phím từ: 0-9) Không
TimeWaitToIvr Thời gian chờ tối đa để người gọi nhấn phím Không
WaitRetry Khoảng cách giữa các lần gọi lại khi người nhận không bắt máy (đơn vị: giây) Không
CallbackUrl Url nhận callback kết quả cuộc gọi (mẫu: http://xxxx.com?ReferenceId=&CallDuration=&CallStatus=&Ivr=&Price=&SentResult&CID=)
-CallDuration: độ dài cuộc gọi
-CallStatus: kết quả cuộc gọi (ANSWERED, NO ANSWER)
-Ivr: phím bấm của khách hàng
-Price: giá cuộc gọi
-SentResult: Kết quả gửi tin qua nhà mạng (0: thất bại, 1: thành công)
-CID: đầu số gửi tin
Không

Response trả về có dạng:

{
"CodeResult": "100",
"SMSID": "8eb2af6d-fb4c-4814-b9cc-4c0e3ed32edf "
}

Thông tin trả về

Trường Ý nghĩa
SMSID ID của tin nhắn thoại mới được tạo ra trên hệ thống eSMS. Dùng ID này để query lấy trạng thái tin nhắn thoại.
CodeResult
Giá trịÝ nghĩa
100Request đã được nhận và xử lý thành công.
106File ghi âm không tồn tại
105Danh sách biến của mẫu tin không hợp lệ
102Chưa có bảng giá
103103 Số dư tài khoản không đủ
99Lỗi không xác định

API tạo cuộc gọi OTP

Theo giao thức GET

Url Request có dạng

Hàm cho phép bạn gửi tin nhắn thoại đến 1 số điện thoại là mã OTP mà bạn muốn gửi đến khách


http://voiceapi.esms.vn/MainService.svc/{ResponseType}/VoiceOTP?ApiKey={ApiKey}&SecretKey={SecretKey}&Phone={Phone}&Code={Code}&Speed={Speed}&Voice={Voice}&Sender={Sender}&CallbackUrl={CallbackUrl}

Request mẫu

http://voiceapi.esms.vn/MainService.svc/json/VoiceOTP?ApiKey=xxxxxxxxx&SecretKey=xxxxxxxxxxxxx&Phone=0842090998&Code=123456&Speed=-3&Voice=hatieumai&Sender=voice_otp_repeat&CallbackUrl=ESMS.VN

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng JSON và XML
Apikey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Secretkey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Phone Số điện thoại người nhận
Code Mã OTP goi đến đến khách hàng
Voice Giọng đọc biến, có các giá trị sau đây:
+ male: giọng nam miền Bắc
+ female: giọng nữ miền Bắc
+ hatieumai: giọng nữ miền Nam
+ ngoclam: giọng nữ Huế
Không
Speed Tốc độ đọc biến, có các giá trị sau đây:
+ -3: rất chậm
+ -2: khá chậm
+ -1: chậm
+ 0: bình thường
+ 1: nhanh
+ 2: khá nhanh
+ 3: rất nhanh
Không
CallbackUrl Url nhận callback kết quả cuộc gọi (mẫu: http://xxxx.com?ReferenceId=&CallDuration=&CallStatus=&Ivr=&Price=&SentResult&CID=)
-CallDuration: độ dài cuộc gọi
-CallStatus: kết quả cuộc gọi (ANSWERED, NO ANSWER)
-Ivr: phím bấm của khách hàng
-Price: giá cuộc gọi
-SentResult: Kết quả gửi tin qua nhà mạng (0: thất bại, 1: thành công)
-CID: đầu số gửi tin
Không

Response trả về có dạng:

{
"CodeResult": "100",
"SMSID": "8eb2af6d-fb4c-4814-b9cc-4c0e3ed32edf "
}

Thông tin trả về

Trường Ý nghĩa
SMSID ID của tin nhắn thoại mới được tạo ra trên hệ thống eSMS. Dùng ID này để query lấy trạng thái tin nhắn thoại.
CodeResult
Giá trịÝ nghĩa
100Request đã được nhận và xử lý thành công.
104Mẫu cuộc gọi không tồn tại
105Danh sách biến của mẫu tin không hợp lệ
102Chưa có bảng giá
103103 Số dư tài khoản không đủ
99Lỗi không xác định
106File ghi âm không tồn tại
107Sai số điện thoại

API lấy số dư

Theo giao thức GET

Url Request có dạng

http://rest.esms.vn/MainService.svc/{ResponseType}/GetBalance/{ApiKey}/{SecretKey}

Request mẫu

http://rest.esms.vn/MainService.svc/xml/GetBalance/123456789/987654321

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ cả json và xml
APIKey Thông tin APIKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
SecretKey Thông tin SecretKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập

Response trả về có dạng:

{
  "Balance": 7527430,
  "CodeResponse": "100",
  "UserID": 0001
}

Thông tin trả về

Trường Ý nghĩa
Balance Tổng số dư trong tài khoản
CodeResponse Kết quả của request
UserID Mã người dùng

ý nghĩa CodeResponse

Ý nghĩa
100 Request thành công
99 Lỗi không xác định , thử lại sau
101 Đăng nhập thất bại (api key hoặc secrect key không đúng)
102 Tài khoản đã bị khóa
103 Số dư tài khoản không đủ dể gửi tin
104 Mã Brandname không đúng

API gửi tin nhắn

Theo giao thức GET

Url Request có dạng

http://rest.esms.vn/MainService.svc/{ResponseType}/SendMultipleMessage_V4_get?Phone={Phone}&Content={Content}&ApiKey={ApiKey}&SecretKey={SecretKey}&IsUnicode={IsUnicode}&Brandname={Brandname}&SmsType={SmsType}&CallBackUrl={CallBackUrl}

Request mẫu

http://rest.esms.vn/MainService.svc/json/SendMultipleMessage_V4_get?Phone=09xxxx&Content=DemoText&ApiKey=xxxx&SecretKey=xxxx&SmsType=2&Brandname=Test

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng XML và JSON
Phone Số điện thoại người nhận
Content Nội dung gửi đến người nhận
ApiKey Thông tin APIKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
SecretKey Thông tin SecretKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
SmsType Là loại tin nhắn muốn sử dụng, mỗi loại sẽ có đầu số hiển thị khác nhau và chi phí khác nhau.Vui long liên hệ hotline 0901.888.484 để được tư vấn cụ thể hơn
Giá trị Ý nghĩa
2 Brandname chăm sóc khách hang Khuyến khích sử dụng loại tin nhắn này. Bạn cần liên hệ nhân viên kinh Doanh hoặc hotline 0901.888.484 để đăng ký Brandname riêng của mình và Brandname test
8 Tin nhắn đầu số cố định 10 số, chuyên dùng cho chăm sóc khách hang. Bạn cần phải đăng ký mẫu tin nhắn trước với bộ phận kinh doanh để đăng ký và sử dụng.
Brandname Tên Brandname (tên công ty hay tổ chức khi gửi tin sẽ hiển thị trên tin nhắn đó). Không (Có khi gửi brandname.)
Sandbox
Ý nghĩa
0 Không thử nghiệm, gửi tin đi thật
1 Thử nghiệm (tin không đi mà chỉ tạo ra tin nhắn)
Không
RequestId ID Tin nhắn của đối tác, dùng để kiểm tra ID này đã được hệ thống esms tiếp nhận trước đó hay chưa.Ví dụ: requestid=123456 Không
SendDate Đặt lịch gửi tin Không
CallBackUrl Đặt lịch gửi tin Không

Response trả về có dạng:

{
    "CodeResult": "100",
    “CountRegenerate”:”0”,
    "SMSID": "24342680"
}

Thông tin trả về

Trường Ý nghĩa
SMSID ID của tin nhắn mới được tạo ra trên hệ thống eSMS. Dùng ID này để query lấy trạng thai tin nhắn.

ý nghĩa CodeResponse

Ý nghĩa
100 Request đã được nhận và xử lý thành công.
104 Brandname không tồn tại hoặc đã bị hủy
118 Loại tin nhắn không hợp lệ
119 Brandname quảng cáo phải gửi ít nhất 20 số điện thoại
131 Tin nhắn brandname quảng cáo độ dài tối đa 422 kí tự
132 Không có quyền gửi tin nhắn đầu số cố định 8755
99 Lỗi không xác định
177 Brandname không có hướng ( Viettel - The Network Viettel have not registry.<br>VinaPhone - The Network VinaPhone have not registry.<br>Mobifone - The Network Mobifone have not registry.<br>Gtel - The Network Gtel have not registry.<br>Vietnammobile - The Network Vietnammoile have not registry.)
159 RequestId quá 120 ký tự
145 Sai template mạng xã hội

Theo giao thức POST

Url Request có dạng

http://rest.esms.vn/MainService.svc/json/SendMultipleMessage_V4_post_json/

Request mẫu

Các bạn cần gọi lệnh POST đến URL ở trên với data POST lên có dạng như sau :
{"ApiKey":"xxxxx","Content":"xxxxx","Phone":"xxxx","SecretKey":"xxxxx","IsUnicode":"x","Brandname":"xxxx","SmsType":"x"}

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng XML và JSON
Phone Số điện thoại người nhận
Content Nội dung gửi đến người nhận
ApiKey Thông tin APIKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
SecretKey Thông tin SecretKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
SmsType Là loại tin nhắn muốn sử dụng, mỗi loại sẽ có đầu số hiển thị khác nhau và chi phí khác nhau.Vui long liên hệ hotline 0901.888.484 để được tư vấn cụ thể hơn
Giá trị Ý nghĩa
2 Brandname chăm sóc khách hang Khuyến khích sử dụng loại tin nhắn này. Bạn cần liên hệ nhân viên kinh Doanh hoặc hotline 0901.888.484 để đăng ký Brandname riêng của mình và Brandname test
8 Tin nhắn đầu số cố định 10 số, chuyên dùng cho chăm sóc khách hang. Bạn cần phải đăng ký mẫu tin nhắn trước với bộ phận kinh doanh để đăng ký và sử dụng.
Brandname Tên Brandname (tên công ty hay tổ chức khi gửi tin sẽ hiển thị trên tin nhắn đó). Không (Có khi gửi brandname.)
Sandbox
Ý nghĩa
0 Không thử nghiệm, gửi tin đi thật
1 Thử nghiệm (tin không đi mà chỉ tạo ra tin nhắn)
Không
RequestId ID Tin nhắn của đối tác, dùng để kiểm tra ID này đã được hệ thống esms tiếp nhận trước đó hay chưa.Ví dụ: requestid=123456 Không
SendDate Đặt lịch gửi tin Không
CallBackUrl Đặt lịch gửi tin Không

Response trả về có dạng:

{
    "CodeResult": "100",
    “CountRegenerate”:”0”,
    "SMSID": "24342680"
}

Thông tin trả về

Trường Ý nghĩa
SMSID ID của tin nhắn mới được tạo ra trên hệ thống eSMS. Dùng ID này để query lấy trạng thai tin nhắn.

ý nghĩa CodeResponse

Ý nghĩa
100 Request đã được nhận và xử lý thành công.
104 Brandname không tồn tại hoặc đã bị hủy
118 Loại tin nhắn không hợp lệ
119 Brandname quảng cáo phải gửi ít nhất 20 số điện thoại
131 Tin nhắn brandname quảng cáo độ dài tối đa 422 kí tự
132 Không có quyền gửi tin nhắn đầu số cố định 8755
99 Lỗi không xác định
177 Brandname không có hướng ( Viettel - The Network Viettel have not registry.<br>VinaPhone - The Network VinaPhone have not registry.<br>Mobifone - The Network Mobifone have not registry.<br>Gtel - The Network Gtel have not registry.<br>Vietnammobile - The Network Vietnammoile have not registry.)
159 RequestId quá 120 ký tự
145 Sai template mạng xã hội

API kiểm tra trạng thái tin nhắn

Theo giao thức GET

Url Request có dạng

http://rest.esms.vn/MainService.svc/{ResponseType}/GetSendStatus?RefId=XXX&ApiKey=XXX&SecretKey=XX_XX
https://restapi.esms.vn/MainService.svc/{ResponseType}/GetSendStatus?RefId=XXX&ApiKey=XXX&SecretKey=XXXX

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng JSON và XML
Apikey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Secretkey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
SmsId ID của SMS được trả về sau khi gọi các lệnh gửi tin.

Response trả về có dạng:

{
   "CodeResponse": "100",
   "SMSID": "24312210",
   SendFailed": 0,
   SendStatus": 5,
   SendSuccess": 1,
   TotalReceiver": 1,
   TotalSent": 1
}

Thông tin trả về

Trường Ý nghĩa
SMSID Mã tin nhắn, được trả về sau khi gọi API gửi tin
SendStatus
Ý nghĩa
1 Đang chờ duyệt
2 Đang chờ gửi
3 Đang gửi
4 Bị từ chối
5 Đã gửi xong
6 Đã bị xóa
TotalSent Tổng số tin nhắn cần gửi
TotalReceiver Tổng số người nhận
SentSuccess Tổng số tin nhắn gửi thành công
SentFailed Tổng số tin nhắn gửi thất bại

API kiểm tra chi tiết từng số trong tin nhắn

Theo giao thức GET

Url Request có dạng

Hàm lấy danh sách số điện thoại của một tin nhắn đã gửi (dựa trên SmsID hệ thống trả về) kèm theo trạng thái gửi (Số điện thoại đó đã gửi thành công chưa?)
http://rest.esms.vn/MainService.svc/{ResponseType}/GetSmsReceiverStatus_get?&ApiKey=XXXX&SecretKey=XXXX&RefId=XXXX

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng JSON và XML
Apikey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Secretkey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
ReftId ID của SMS được trả về sau khi gọi các lệnh gửi tin.

Response trả về có dạng:

{
    "CodeResult": "100",
    ReceiverList": [
      {
      "IsSent": true,
      "Phone": "XXXX",
      "SentResult": true
      }
    
}

ý nghĩa CodeResponse

Ý nghĩa
105 Id không tồn tại trong hệ thống.

API lấy danh sách tin nhắn theo khoảng thời gian

Theo giao thức POST

Url Request có dạng

http://rest.esms.vn/MainService.svc/{ResponseType}/GetSmsSentData

Request mẫu

Các bạn cần gọi lệnh POST đến URL ở trên với data POST lên có dạng như sau:

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng JSON và XML
Apikey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Secretkey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
From Thời gian bắt đầu (Định dạng: MM/dd/YYYY)
To Thời gian kết thúc (Định dạng: MM/dd/YYYY)

Thông tin trả về

Trường Ý nghĩa
SentTime Thời gian gửi
SmsId Id cảu tin nhắn
Phone Số điện thoại
Content Nội dung
SmsType Loại tin nhắn
SentStatus Trạng thái gửi
CodeResult Mã kết quả của request
ErrorMessage Chi tiêt lỗi nếu có

ý nghĩa CodeResponse

Ý nghĩa
140 Thời gian không hợp lệ

API lấy danh sách brandname

Theo giao thức GET

Url Request có dạng

http://rest.esms.vn/MainService.svc/{ResponseType}/GetListBrandname/{ApiKey}/{SecretKey}

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng JSON và XML
Apikey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Secretkey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)

Response trả về có dạng:

{
  "CodeResponse": "100",
  "ListBrandName": [
  {
    "Brandname": "Test_Sang",
    "Type": 2
  },
  {
    "Brandname": "sangbrand",
    "Type": 2
  }
  ]
}

Thông tin trả về

Trường Ý nghĩa
Brandname Brandname đăng ký
Type
Ý nghĩa
1Quảng cáo
2Chăm sóc khách hàng

ý nghĩa CodeResponse

Ý nghĩa
101 Sai Api or Secretkey

API lấy trạng thái cuộc gọi

Theo giao thức GET

Url Request có dạng

http://voiceapi.esms.vn/MainService.svc/{ResponseType}/GetSendStatus?ReferenceId={ReferenceId}&ApiKey={ApiKey}&SecretKey={SecretKey}

Request mẫu

http://voiceapi.esms.vn/MainService.svc/xml/GetSendStatus?ApiKey=xxxx&SecretKey=xxxx&ReferenceId=xxxx

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ cả json và xml
ReferenceId Id cuộc gọi trả về sau khi gọi request tạo cuộc gọi
APIKey Thông tin APIKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
SecretKey Thông tin SecretKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập

Response trả về có dạng:

{
  "CodeResponse": "100",
  "callduration": 24,
  "callstatus": "ANSWERED",
  "ivr": "2"
}

Thông tin trả về

Trường Ý nghĩa
CodeResponse Kết quả của Request
Giá trịÝ nghĩa
100Request hợp lệ.
105Không tìm thấy cuộc gọi
101Sai ApiKey hoặc SecretKey
CallStatus Kết quả của cuộc gọi (ANSWERED: cuộc gọi được trả lời, NOANSWERED: cuộc gọi thất bại hoặc không ai bắt máy)
CallDuration Số giây cuộc gọi thực hiện
Ivr Phím phản hồi của người nghe

API tạo cuộc gọi tự động theo Template

Theo giao thức GET

Hàm cho phép bạn gửi tin nhắn thoại đến 1 số điện thoại bởi mẫu cuộc gọi đã được tạo sẵn trên hệ thống.

Url Request có dạng

http://voiceapi.esms.vn/MainService.svc/{ResponseType}/MakeCallTemplate_V2?ApiKey={ApiKey}&SecretKey={SecretKey}&TemplateId={TemplateId}&Phone={Phone}&VariableListStr={VariableListStr}&SendDate={SendDate}&Voice={Voice}&Speed={Speed}&CallbackUrl={CallbackUrl}

Request mẫu

http://voiceapi.esms.vn/MainService.svc/xml/MakeCallTemplate_V2?ApiKey=xxxx&SecretKey=xxxx&TemplateId=xxxx&Phone=xxxx&VariableListStr=xxxx

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng XML và JSON
Phone Số điện thoại người nhận
TemplateId Id mẫu cuộc gọi đăng ký trên trang account.esms.vn
ApiKey Thông tin APIKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
SecretKey Thông tin SecretKey được cấp khi đăng ký trong phần Quản lý API sau khi đăng nhập
VariableListStr Chuỗi biến chứa danh sách giá trị các biến của mẫu cuộc gọi, cách nhau bởi dấu “||”, thứ tự các biến từ trái sang phải.
Ví dụ: Trung||20000 (Giá trị biến 1: Trung, Giá trị biến 2: 20000)
Có (Có khi mẫu cuộc gọi có biến)
SendDate Đặt lịch gửi tin (định dạng: yyyy/MM/dd hh:mm:ss)Ví dụ: 2017/12/12 14:00:00 Không
Voice Giọng đọc biến, có các giá trị sau đây:
+ male: giọng nam miền Bắc
+ female: giọng nữ miền Bắc
+ hatieumai: giọng nữ miền Nam
+ ngoclam: giọng nữ Huế
Không
Speed Tốc độ đọc biến, có các giá trị sau đây:
+ -3: rất chậm
+ -2: khá chậm
+ -1: chậm
+ 0: bình thường
+ 1: nhanh
+ 2: khá nhanh
+ 3: rất nhanh
Không

Response trả về có dạng:

{
"CodeResult": "100",
"SMSID": "8eb2af6d-fb4c-4814-b9cc-4c0e3ed32edf "
}

Thông tin trả về

Trường Ý nghĩa
SMSID ID của tin nhắn thoại mới được tạo ra trên hệ thống eSMS. Dùng ID này để query lấy trạng thái tin nhắn thoại.
CodeResult
Giá trịÝ nghĩa
100Request đã được nhận và xử lý thành công.
104Danh sách biến của mẫu tin không hợp lệ
105Danh sách biến của mẫu tin không hợp lệ
102Chưa có bảng giá
103103 Số dư tài khoản không đủ
99Lỗi không xác định

API tạo cuộc gọi tự động từ file ghi âm

Theo giao thức GET

Url Request có dạng

http://voiceapi.esms.vn/MainService.svc/{ResponseType}MakeCallRecord_V2?ApiKey={ApiKey}&SecretKey={SecretKey}&TemplateId={RecordId}&Phone={Phone}&SendDate={SendDate}&NumberForward={NumberForward}&MaxRepeat={MaxRepeat}&MaxRetry={MaxRetry}&Ivr={Ivr}&TimeWaitToIvr={TimeWaitToIvr}&WaitRetry={WaitRetry}&CallbackUrl={CallbackUrl}

Request mẫu

http://voiceapi.esms.vn/MainService.svc/xml/MakeCallRecord_V2?ApiKey=xxxx&SecretKey=xxxx&TemplateId=xxxx&Phone=xxxx&SendDate=2017/12/12 14:00:00

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng JSON và XML
Apikey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Secretkey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Phone Số điện thoại người nhận
TemplateId Id file ghi âm tạo trên trang account.esms.vn
NumberForward Số điện thoại được chuyển đến khi nhập đúng Ivr Không
SendDate Đặt lịch gửi tin (định dạng: yyyy/MM/dd hh:mm:ss)Ví dụ: 2017/12/12 14:00:00 Không
MaxRepeat Số lần lặp lại file ghi âm khi nghe Không
MaxRetry Số lần gọi lại khi người nhận không bắt máy Không
Ivr Phím quy định khi người nhận bấm để chuyển số (phím từ: 0-9) Không
TimeWaitToIvr Thời gian chờ tối đa để người gọi nhấn phím Không
WaitRetry Khoảng cách giữa các lần gọi lại khi người nhận không bắt máy (đơn vị: giây) Không
CallbackUrl Url nhận callback kết quả cuộc gọi (mẫu: http://xxxx.com?ReferenceId=&CallDuration=&CallStatus=&Ivr=&Price=&SentResult&CID=)
-CallDuration: độ dài cuộc gọi
-CallStatus: kết quả cuộc gọi (ANSWERED, NO ANSWER)
-Ivr: phím bấm của khách hàng
-Price: giá cuộc gọi
-SentResult: Kết quả gửi tin qua nhà mạng (0: thất bại, 1: thành công)
-CID: đầu số gửi tin
Không

Response trả về có dạng:

{
"CodeResult": "100",
"SMSID": "8eb2af6d-fb4c-4814-b9cc-4c0e3ed32edf "
}

Thông tin trả về

Trường Ý nghĩa
SMSID ID của tin nhắn thoại mới được tạo ra trên hệ thống eSMS. Dùng ID này để query lấy trạng thái tin nhắn thoại.
CodeResult
Giá trịÝ nghĩa
100Request đã được nhận và xử lý thành công.
106File ghi âm không tồn tại
105Danh sách biến của mẫu tin không hợp lệ
102Chưa có bảng giá
103103 Số dư tài khoản không đủ
99Lỗi không xác định

API tạo cuộc gọi OTP

Theo giao thức GET

Url Request có dạng

Hàm cho phép bạn gửi tin nhắn thoại đến 1 số điện thoại là mã OTP mà bạn muốn gửi đến khách


http://voiceapi.esms.vn/MainService.svc/{ResponseType}/VoiceOTP?ApiKey={ApiKey}&SecretKey={SecretKey}&Phone={Phone}&Code={Code}&Speed={Speed}&Voice={Voice}&Sender={Sender}&CallbackUrl={CallbackUrl}

Request mẫu

http://voiceapi.esms.vn/MainService.svc/json/VoiceOTP?ApiKey=xxxxxxxxx&SecretKey=xxxxxxxxxxxxx&Phone=0842090998&Code=123456&Speed=-3&Voice=hatieumai&Sender=voice_otp_repeat&CallbackUrl=ESMS.VN

Thông số

Tham số Mô tả Bắt buộc
ResponseType Hỗ trợ định dạng JSON và XML
Apikey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Secretkey Dùng để sử dụng esms api.(cung cấp khi đăng ký tài khoản tại esms.vn)
Phone Số điện thoại người nhận
Code Mã OTP goi đến đến khách hàng
Voice Giọng đọc biến, có các giá trị sau đây:
+ male: giọng nam miền Bắc
+ female: giọng nữ miền Bắc
+ hatieumai: giọng nữ miền Nam
+ ngoclam: giọng nữ Huế
Không
Speed Tốc độ đọc biến, có các giá trị sau đây:
+ -3: rất chậm
+ -2: khá chậm
+ -1: chậm
+ 0: bình thường
+ 1: nhanh
+ 2: khá nhanh
+ 3: rất nhanh
Không
CallbackUrl Url nhận callback kết quả cuộc gọi (mẫu: http://xxxx.com?ReferenceId=&CallDuration=&CallStatus=&Ivr=&Price=&SentResult&CID=)
-CallDuration: độ dài cuộc gọi
-CallStatus: kết quả cuộc gọi (ANSWERED, NO ANSWER)
-Ivr: phím bấm của khách hàng
-Price: giá cuộc gọi
-SentResult: Kết quả gửi tin qua nhà mạng (0: thất bại, 1: thành công)
-CID: đầu số gửi tin
Không

Response trả về có dạng:

{
"CodeResult": "100",
"SMSID": "8eb2af6d-fb4c-4814-b9cc-4c0e3ed32edf "
}

Thông tin trả về

Trường Ý nghĩa
SMSID ID của tin nhắn thoại mới được tạo ra trên hệ thống eSMS. Dùng ID này để query lấy trạng thái tin nhắn thoại.
CodeResult
Giá trịÝ nghĩa
100Request đã được nhận và xử lý thành công.
104Mẫu cuộc gọi không tồn tại
105Danh sách biến của mẫu tin không hợp lệ
102Chưa có bảng giá
103103 Số dư tài khoản không đủ
99Lỗi không xác định
106File ghi âm không tồn tại
107Sai số điện thoại