Skip to main content

Danh sách API

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ínhKiểu dữ liệuGiá trị
x-auth-app-idStringĐịnh danh 3rd party
x-auth-app-hashStringsha256(appId + appSecret)

Kết quả:

StatusKết quả
200{ value: <auth_token>, expire: <expire time> }

Click to call

URL: /oapi/v1/call/click-to-call/:number

METHOD: POST

Content Type: application/json‌

Headers:

Thuộc tínhKiểu dữ liệuGiá trị
x-auth-app-idStringĐịnh danh 3rd party
x-auth-app-hashStringsha256(appId + appSecret)

Tham số:

Thuộc tínhKiểu dữ liệuGiá trị
sipUserStringDevice name thực hiện việc click to call
sipPasswordStringMật khẩu

Kết quả:‌

StatusKết quả
200Device online, click to call thành công
400Device offline, click to call thất bại
note

Để 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

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

URL: /oapi/v1/call/histories‌

METHOD: GET‌

Content Type: application/json‌

Tham số:

Thuộc tínhKiểu dữ liệuGiá trị
appIdStringĐịnh danh 3rd party
created_fromStringNgày bắt đầu
created_toStringNgày kết thúc
limitNumberGiới hạn số record trên 1 trang. Mặc định 20
pageNumberTrang hiện tại, mặc định 1
hashStringsha256(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ínhVí 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.
classtrunkingone_one: gọi nội bộ. trunking: gọi ra hoặc gọi vào hệ thống
did_number02873019555Số DID của công ty. Null: nếu gọi nội bộ hoặc gọi ra
directionfrom_abfrom_ab: gọi ra. to_ab: gọi vào
status_detailSUCCESSIVR: 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. UNSUCCESS: Các lỗi khác
duration_seconds50Thời gian cuộc gọi ( tính bằng giây)
unix_timestamp1519639917Thời điểm xảy ra cuộc gọi. Tính theo unix timestamp
billing_seconds43Thời gian đàm thoại của cuộc gọi ( tính bằng giây)
recordingcall_recording_dl5m5j5hfh4n8njj1oor.mp3File 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‌

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ệuMô tả
appIdStringĐịnh danh 3rd party
mediaStringTên file recording
hashStringsha256(appId +media+ appSecret)

Kết quả:‌

Đường dẫn URL của file media

Thuộc tínhVí dụMô tả
mediahttps://abs1.antbuddy.com/nkrecord/call_recording_F5879958-1A1211E8-A55AA457-72574952%40172.16.0.204.mp3?AWSAccessKeyId=E7IPYE4LN28Y4I6T4400&Expires=1519640615&Signature=wXNENYxr0OJR8vA26kvOOwsttzU%3D​Đường dẫn file ghi âm