search
Đăng nhập

Create an auto-call using 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.

hashtag
HTTP request

GET 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}}arrow-up-right

  • 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:

Request hợp lệ.

  • 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.

PreviousCreate voice OTP callNextCreate a call from recording file