Hàm tạo cuộc gọi tự động từ file ghi âm
Hàm cho phép bạn gửi tin nhắn thoại đến 1 số điện thoại bởi file ghi âm đã tạo.
Last updated
Hàm cho phép bạn gửi tin nhắn thoại đến 1 số điện thoại bởi file ghi âm đã tạo.
Last updated
GET
https://voiceapi.esms.vn/MainService.svc/json/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}}&RequestID={{RequestId}}
Response Type: application/json
Cấu trúc body của request:
Tham số | Kiểu dữ liệu | Tính bắt buộc | Mô tả |
---|---|---|---|
Response:
Request hợp lệ.
Cấu trúc body của response:
Thông tin chi tiết mã lỗi xem ở bảng: Mã lỗi .
Lấy code mẫu các ngôn ngữ trên Postman: Link code mẫu.
Thuộc tính | Kiểu dữ liệu | Mô tả |
---|---|---|
ApiKey
string
ApiKey của tài khoản
SecretKey
string
Secretkey của tài khoản
TemplateId
string
Id file ghi âm tạo trên trang account.esms.vn
Phone
string
Số điện thoại nhận tin
NumberForward
string
Số điện thoại được chuyển đến khi nhập đúng Ivr
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
MaxRepeat
string
Số lần lặp lại file ghi âm khi nghe
MaxRetry
string
Số lần gọi lại khi người nhận không bắt máy
Ivr
string
Phím quy định khi người nhận bấm để chuyển số (phím từ: 0-9)
TimeWaitToIvr
string
Thời gian chờ tối đa để người gọi nhấn phím
WaitRetry
string
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)
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'
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
CodeResult
String
Mã trả về.
SMSID
String
ID tin nhắn do esms trả về.
ErrorMessage
String
Thông tin lỗi trả về (nếu có lỗi).