Danh sách API

1. Get auth token

Sử dụng cho việc nhận websocket về các signal của cuộc gọi
URL: /oapi/v1/voice/auth_token
METHOD: POST
Content Type: application/json‌
Headers:
Thuộc tính
Kiểu dữ
Giá trị
x-auth-app-id
String
Định danh 3rd party
x-auth-app-hash
Str
sha256(appId + appSecret)
Tham số:
Thuộc tính
Kiểu dữ li
Giá trị
sipUser
String
Device name thực hiện việc click to call
sipPassword
String
Mật khẩu
Kết quả:
Status
Kết
200
{ value: <auth_token>, expire: <expire time> }

2. Click to call

URL: /oapi/v1/call/click-to-call/:number
METHOD: POST
Content Type: application/json‌
Headers:
Thuộc tính
Kiểu dữ
Giá trị
x-auth-app-id
String
Định danh 3rd party
x-auth-app-hash
Str
sha256(appId + appSecret)
Tham số:
Thuộc tính
Kiểu dữ li
Giá trị
sipUser
String
Device name thực hiện việc click to call
sipPassword
String
Mật khẩu
Kết quả:
Status
Kết
200
Device online, click to call thành công
400
Device offline, click to call thất bại
Chú ý: để nhận được cuộc gọi, device sip cần register lên hệ thống, mã lỗi 400 là do device chưa register đến hệ thống

3. Lấy danh sách cuộc gọi

URL: /oapi/v1/call/histories‌
METHOD: GET
Content Type: application/json‌
Tham số:
Tham số
Kiễu dữ liệu
Mô tả
appId
String
Định danh 3rd party
created_from
String
Ngày bắt đầu
created_to
String
Ngày kết thúc
limit
Number
Giới hạn số record trên 1 trang. Mặc định 20
page
Number
Trang hiện tại, mặc định 1
hash
String
sha256(appId+created_from+created_to+limit+page+appSecret)
Trong đó:
  • Thời gian filter tối đa là 31 ngày
  • Limit mặc định là 20 record, tối đa 100
  • Page mặc định là 1
Kết quả:
Thuộc tính
Ví dụ
Mô tả
caller
{
number:"01693608879",
type:"realnumber"
}
Mô tả người gọi. Đối với type=user, có thêm trường username để định danh user.
callee
{
number:"thutranhtkbee",
type:"user",
username:"thutran"
}
Mô tả người nhận. Đối với type=user, có thêm trường username để định danh user.
class
trunking
one_one: gọi nội bộ. trunking: gọi ra hoặc gọi vào hệ thống
did_number
02873019555
Số DID của công ty. Null: nếu gọi nội bộ hoặc gọi ra
direction
from_ab
from_ab: gọi ra. to_ab: gọi vào
status_detail
SUCCESS
IVR: Cuộc gọi vào / ra đến hệ thống đầu cuối nhưng người nhận chưa bắt máy. SUCCESS: Cuộc gọi thành công. CANCELLED: Thực hiện cuộc gọi ra và gác máy trước khi người nhận nhận cuộc gọi. BUSY: Thực hiện cuộc gọi ra nhưng đầu nhận bận máy. ERROR: Các lỗi khác
duration_seconds
50
Thời gian cuộc gọi ( tính bằng giây)
unix_timestamp
1519639917
Thời điểm xảy ra cuộc gọi. Tính theo unix timestamp
billing_seconds
43
Thời gian đàm thoại của cuộc gọi ( tính bằng giây)
recording
call_recording_dl5m5j5hfh4n8njj1oor.mp3
File ghi âm. Trường hợp không có ghi âm thì trường này rỗng.
Giới hạn:
Chỉ cho phép lấy lịch sử cuộc gọi tối đa 31 ngày‌

4. Lấy file ghi âm

URL: /oapi/v1/call/play_recording‌
METHOD: GET‌
Content Type: application/json‌
Tham số:
Tham số
Kiễu dữ liệu
Mô tả
appId
String
Định danh 3rd party
media
String
Tên file recording
hash
String
sha256(appId +media+ appSecret)
Kết quả:
Đường dẫn URL của file media
Last modified 3mo ago