eSMS for Developers
Đăng nhập
VN - eSMS for Developers
VN - eSMS for Developers
  • Tổng quan hệ thống
    • Giới thiệu hệ thống API
    • Cơ chế hoạt động
    • Lấy thông tin ApiKey và SecretKey
  • eSMS API
    • Hàm gửi tin
      • Tin nhắn SMS OTP/CSKH (Khuyên Dùng)
      • Tin nhắn Zalo
      • Tin nhắn đa kênh: Zalo => SMS OTP/CSKH
      • Tin nhắn Zalo sử dụng hash phone
      • Tin Zalo mỗi khách hàng một nội dung
      • Tin Zalo Tư vấn dạng văn bản
      • Tin Zalo Tư vấn đính kèm ảnh
      • Tin Zalo Tư vấn dạng button
      • Tin Zalo giao dịch
      • Tin Zalo Tư vấn dạng yêu cầu thông tin người dùng
      • Tin Zalo hành trình
      • Tạo và gửi mã xác thực tự động bằng tin nhắn SMS
      • Tạo và gửi mã xác thực tự động đa kênh: Zalo => SMS
      • Tin Viber
      • Tin SMS quảng cáo
      • Tin Voice OTP
    • Hàm truy xuất và đăng ký
      • Hàm lấy số dư tài khoản
      • Hàm kiểm tra trạng thái tin nhắn theo khoảng thời gian
      • Hàm kiểm tra tin nhắn theo SMSID
      • Hàm kiểm tra chi tiết từng số trong tin nhắn
      • Hàm lấy danh sách Brandname
      • Hàm lấy danh sách template tin chăm sóc khách hàng
      • Hàm tạm tính giá tin nhắn CSKH
      • Hàm tạm tính giá tin nhắn quảng cáo
      • Hàm lấy danh sách Zalo OA
      • Hàm lấy danh sách template Zalo
      • Hàm tạm tính giá tin Zalo
      • Lấy quota tin zalo theo OAID
      • Hàm lấy thông tin đánh giá của khách hàng
      • Hàm kiểm tra chất lượng OA
      • Hàm lấy danh sách UID có tương tác theo khoảng thời gian
      • Hàm lấy thông tin callback tin nhắn Zalo
      • Hàm lấy thông tin chi tiết template Zalo
      • Hàm đăng ký mua gói OA
      • Hàm đăng ký template Zalo
      • Hàm đăng ký template SMS
    • Các API khác
      • Gửi tin chăm sóc khách hàng dạng GET
      • Gửi tin chăm sóc khách hàng dạng POST X-Form
      • Gửi tin chăm sóc khách hàng dạng POST TEXT
      • Gửi tin cố định giá rẻ dạng GET
      • Gửi tin quảng cáo dạng POST TEXT
      • Hàm gửi tin Zalo V4
      • Hàm gửi tin Zalo V5
      • Hàm gửi tin nhắn Zalo dạng X-Form
      • Hàm gửi tin nhắn Zalo dạng Json Full template
      • Hàm gửi tin nhắn Viber dạng GET
      • Hàm check code
    • Kết nối mã SVoucher
      • Kết nối đầu số ngắn
    • Hàm gọi Voice
      • Hàm tạo cuộc gọi voice OTP
      • Hàm tạo cuộc gọi tự động theo Template
      • Hàm tạo cuộc gọi tự động từ file ghi âm
      • Hàm lấy trạng thái cuộc gọi
    • Bảng mã lỗi
    • Môi trường test ( Sandbox)
    • Callback Url
Powered by GitBook
On this page
  1. eSMS API
  2. Hàm gọi Voice

Hàm tạo cuộc gọi tự động theo Template

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.

PreviousHàm tạo cuộc gọi voice OTPNextHàm tạo cuộc gọi tự động từ file ghi âm

Last updated 1 year ago

HTTP request

GET

  • Response Type: application/json

curl --location --globoff 'https://voiceapi.esms.vn/MainService.svc/json/MakeCallTemplate_V2?ApiKey={{ApiKey}}&SecretKey={{SecretKey}}&TemplateId={{TemplateId}}&Phone={{Phone}}&VariableListStr={{VariableListStr}}&SendDate={{SendDate}}&Voice={{Voice}}&Speed={{Speed}}&CallbackUrl={{CallbackUrl}}&RequestId={{RequestId}}'
  • Cấu trúc body của request::

Tham số
Kiểu dữ liệu
Tính bắt buộc
Mô tả

ApiKey

string

ApiKey của tài khoản

SecretKey

string

Secretkey của tài khoản

TemplateId

string

Id kịch bản cuộc gọi đăng ký trên trang account.esms.vn

Phone

string

Số điện thoại nhận tin

VariableListStr

string

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)

SendDate

string

Đặt lịch gửi tin (định dạng: yyyy/MM/dd hh:mm:ss) Ví dụ: 2017/12/12 14:00:00

Voice

string

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ế

Speed

string

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

RequestId

string

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

CallbackUrl

string (URL Encode)

Url nhận callback kết quả cuộc gọi (mẫu: https://{{Your_API_Domain}}/Esms/ReceiveVocieCallback?ReferenceId=&CallDuration=&CallStatus=&Ivr=&Price=&SentResult=&CID=&SendStatus=)

  • 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

  • SendStatus: Trạng thái cuộc gọi:

2: Chờ gửi.

5: Đã gửi xong.

7: Đã gửi chờ báo cáo.

Yêu cầu phản hồi:

Khi đối tác nhận được dữ liệu, vui lòng trả về trạng thái HTTP_STATUS_CODE=200 để xác nhận với ESMS là thành công.

Nếu không nhận được HTTP_STATUS_CODE 200, ESMS sẽ tiến hành gửi lại tối đa 5 lần. Ví dụ: curl --location --globoff --request GET 'https://{{Your_API_Domain}}/Esms/ReceiveVocieCallback?ReferenceId=066107ee-6ec4-4283-b595-aa74977c65c5&CallDuration=0&CallStatus=&Ivr=&Price=0.0000&SentResult=0&CID=02871002454&SendStatus=5'


  • Response:

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

Request hợp lệ.

{
    "CodeResult": "101",
    "ErrorMessage": "Authorize Failed"
}

Sai thông tin ApiKey/SecretKey.

{
    "CodeResult": "104",
    "ErrorMessage": "Template not found"
}

TemplateId không tổng

  • Cấu trúc body của response:

Thuộc tính
Kiểu dữ liệu
Mô tả

CodeResult

string

Mã trả về.

SMSID

string

ID của cuộcgoji mới được tạo ra trên hệ thống eSMS. Dùng ID này để query lấy trạng thái cuộc gọi.

Thông tin chi tiết mã lỗi xem ở bảng: .

Lấy code mẫu các ngôn ngữ trên Postman: .

https://voiceapi.esms.vn/MainService.svc/json/MakeCallTemplate_V2?ApiKey={{ApiKey}}&SecretKey={{SecretKey}}&TemplateId={{TemplateId}}&Phone={{Phone}}&VariableListStr={{VariableListStr}}&SendDate={{SendDate}}&Voice={{Voice}}&Speed={{Speed}}&CallbackUrl={{CallbackUrl}}&RequestId={{RequestId}}
Mã lỗi
Link code mẫu