Hướng dẫn kết nối API CloudFone

API kết nối trang quản trị tổng đài

Lấy thông tin lịch sử cuộc gọi của tổng đài

API: Method: POST Tham số truyền vào:

{

 "ServiceName" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone

 "AuthUser" : "CF1131",     là Thông tin User Của CloudFone

 "AuthKey" : "28ccef8edaf5471d8f302c47df6faa",   là Key CloudFone cung cấp

 "TypeGet" : 0,  là 0: tất cả, 1: gọi đến, 2: gọi đi, 3: gọi nội bộ, 4: gợi nhở, 5: gọi nhóm

 "DateStart":"2017-07-01 00:00:00",  là ngày bắt đầu (nếu truyền ngày vào ” 2017-07-01”, hệ thống sẽ tự hiểu “2017-07-01 00:00:00”)

 "DateEnd" : "2017-07-01 23:59:59", là ngày kết thúc

 "CallNum":"", là Số gọi

 "ReceiveNum":"", là Số nhận

 "Key" : "", là Mã cuộc gọi / hoặc mã KeySearch khi sử dụng các API Autocall

 "PageIndex" : 1, là Số trang

 "PageSize" : 20  là Số dòng trong 1 trang max là 200

}

Kết quả trả về:

{

"result": "success",

"message": "",

"total": 2262,  là tổng số kết quả đối với thông tin nhập bên trên.

"data": [

{

"stt": 1,

"key": "1513557288-01682909240",

"ngayGoi": "2017-12-18T07:34:48",

"soGoiDen": ""Nguyen Thi Thuy Phuong "<401>",

"dauSo": "FPT02473049779",

"soNhan": "01682909240",

"trangThai": "ANSWERED",

"tongThoiGianGoi": "05:01",

"thoiGianThucGoi": "281",

"linkFile": "http://download.cloudfone.vn/Home?ID=NssPGc6AjFri8CaOkBP0Dj7Qo%2fhQW2LKkBhbl2Q1jjMkYxDIqPlAeAw9bA13qW4EsrCCQnJrT%2fNMNP6XagHKx5gYwnRUEmduGDTGDPWxe7%2fN5QlXkGYCZQ%3d%3d"

}

]}

Chức năng ClickToCall gọi cho khách hàng theo thông tin truyền vào – Not WebRTC

API: Method: POST Tham số truyền vào:

{

"ServiceName" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone

"AuthUser" : "CF1131",     là Thông tin User Của CloudFone

"AuthKey" : "28ccef8edaf5471d8f302c4771f6faa",   là Key CloudFone cung cấp

"Prefix" : "0",  mặc định là 0 có thể lấy thông tin Outbound trên trang manage.cloudfone.vn

"Ext":"4209",  là số nội bộ của nhân viên

"PhoneName" : "Manh",  là tên khách hàng

"PhoneNumber" : "0978494119",  là số máy khách hàng.

"KeySearch": "1b38fbda-4b7e-XXXXXXXXXXXXXXX"  là Key để tìm kiếm cuộc gọi ClickToCall này – nếu không truyền CF tự động random key trả về

}

Lưu ý: thông tin KeySearch truyền vào khuyến khích nên là chuỗi mã GUID bao gồm (chữ, số, dấu gạch nối). Kết quả trả về:

{

"result": "success",

"message": "GỌI TỰ ĐỘNG THÀNH CÔNG",

"keySearch": "1b38fbda-4b7e-XXXXXXXXXXXXXXX"

}

Chức năng tự động gọi cho khách hàng theo thông tin truyền vào

API: https://api.cloudfone.vn/api/CloudFone/AutoCallV2 Method: POST Hệ thống sẽ gọi đến số Khách Hàng trước – KH nhấc máy à cuộc gọi được chuyển tiếp đến hướng đích. Tham số truyền vào:

{

"ServiceName" : "CF-P-XXXX",  là Thông tin có khi mua dịch vụ Tổng Đài

"AuthUser" : "CFXXXX",     là Thông tin User Của Tổng Đài

"AuthKey" : "4168a9e16e404aXXXXXXXXXXXXX",   là Key CloudFone cung cấp

"Ext": "C2C-HCM", là Tên điều hướng cuộc gọi sau khi Khách Hàng bắt máy

"PhoneNumber" : "ITELE842877XXXX/09789XXXXX",  là tên đầu số / số máy khách hàng.

"KeySearch": "1b38fbda-4b7e-XXXXXXXXXXXXXXX"

}

<Tên đầu số> Quản Trị Viên lấy thông tin trong Menu Trạng Thái – Trạng Thái Đầu Số <Tên điều hướng> Tương ứng với cấu hình Định Tuyến trên trang tổng đài.

Chức năng hệ thống sẽ tự động post dự liệu qua link của khách hàng khi có cuộc gọi tới

API: Link do bên khách hàng cung cấp Method: POST Tham số truyền vào:

{

"ApiKey" : "xxxxxx",  là Thông tin khách hàng cung cấp

"CallNumber" : ”Số gọi (người gọi)",

"CallName" : ”Tên người gọi tới",

"ReceiptNumber" : ”Số nhận (người nhận)",

"Key" : ”Mã cuộc gọi",Dùng tìm kiếm cuộc gọi .

"KeyRinging" : ”Mã cuộc gọi lúc đổ chuông",

"Status":" Ringing", trạng thái cuộc gọi: Ringing: đổ chuông ,Up: nghe máy, Down: gác máy

"Message" : ”Số nội bộ - Số khách hàng – Tên khách hàng"     Thông tin trả về số máy nhánh được gọi - số điện thoại và tên khách hàng (nếu có trong danh bạ)

}

API kết nối Autocall

Thêm chiến dịch

API:

Method: POST Tham số truyền vào:

{

"AuthUser":"ODS1131",  là Thông tin mã KH có khi mua dịch vụ CloudFone

"AuthKey":"fe8ae3db-19df-4edd-bd0d-5118ac62001b", là Thông tin có khi mua dịch vụ CloudFone

"ServiceCode":"CF-XXXXX", à Mã dịch vụ KH có khi mua dịch vụ CloudFone

"CampaignName":"đây là chiến dịch test từ api lần",  là Tên chiến dịch

"CampaignId":"d91c4b4e-1aa9-4d75-9663-4d9b644617e4",  là Mã chiến dịch,nếu truyền mã chiến dịch vô thì cập nhật,nếu không truyền vô thì tạo mới chiến dịch

"Audios":[{       là danh sách đối tượng âm thanh cho chiến dịch, hiện tại cung cấp 2 loại âm thanh i => invalid keypress và s => âm thanh bắt đầu

"DTMF":"s",  là Ký hiệu âm thanh bắt đầu khi chạy chiến dịch

"ActionParam":"41" là Mã id của file âm thanh

},

{

"DTMF":"i",  là Ký hiệu âm thanh phát khi bấm phím sai

"ActionParam":"41" là Mã id của file âm thanh

}

],

"Keypress":[{ là Danh sách đối tượng phím bấm cho chiến dịch

"Key":"1", là Phím bấm

"Action":"5" là Hành động khi phím cấu hình được bấm

},

{

"Key":"2", là Phím bấm

"Action":"6" là Hành động khi phím cấu hình được bấm

}]

,

"APIURL":"http://wc3school.com", là URL api do KH cung cấp,có thể ko cấu hình

"APIKEY":"213234234lk232423423432l", là Mã key api của KH,có thể ko cấu hình

"ContactID":1006, là ID nhóm danh bạ KH tạo ra ở api số 11

"Trunk":"CF-BS0000003", là Tên trunk của KH(tương ứng với mã dịch vụ KH)

"TimeStartCall":"2018-10-19 16:44:00.000" là Thời gian bắt đầu chiến dịch

}

Kết quả trả về:

{

{

"result": "success",

"message": "Thêm chiến dịch từ API thành công!",

"data": "mã chiến dịch"

}

}

Lấy danh sách chiến dịch

API: Method: POST Tham số truyền vào:

{

"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone

"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone

"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp

"Status" : 0,   là Trạng thái chiến dịch cần lấy (0:đang chờ,1:đang chạy,2:đã chạy xong,3:lấy tất cả)

"PageIndex" : 1,  là Số thứ tự của trang lấy dữ liệu, mặc định là 1.

"PageSize ":20,  là Tổng số dòng hiển thị trên trang

"Key" : "key words to find",  là từ khóa tìm kiếm chiến dịch

}

Kết quả trả về:

{
"result": "success",
"message": "",
"total": 2262,  là tổng số kết quả đối với thông tin nhập bên trên.
"data": [{ }]
}

Lấy danh sách hành động của phím bấm cấu hình mặc định

API: Method: POST Tham số truyền vào:

{
"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone
"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone
"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   à Key CloudFone cung cấp
}

Kết quả trả về:

{
"result": "success",
"message": "",
"data": [{}]
}

Xóa chiến dịch

API: Method: POST Tham số truyền vào:

{
"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone
"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone
"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp,
"Id" : "79acf608-f5ab-4b44-8f16-72ce7ff699c3",   là Mã chiến dịch
}

Kết quả trả về:

{
"result": "success",
"message": ""
}

Lấy thông tin chi tiết của Chiến dịch

API: Method: POST Tham số truyền vào:

{
"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone
"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone
"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp
"Id" : "79acf608-f5ab-4b44-8f16-72ce7ff699c3",   là Mã chiến dịch
}

Kết quả trả về:

{
"result": "success",
"message": "",
"data": [{}]
}

Lấy danh sách trunk(Mã DV) của KH

API: GetTrunkList Method: POST Tham số truyền vào:

{
"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone
"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone
"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp
}

Kết quả trả về:

{
"result": "success",
"message": "",
"data": [{}]
}

Audio

Tạo file âm thanh từ api

API: CreateTTSAudio Method: POST Tham số truyền vào:

{

"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone
"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone
"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp
"Content" : "Chào mọi người, chúc mọi người buổi sáng vui vẻ.",   là Nội dung cần tạo file audio, Nếu Type là File thì Content truyền vào là chuỗi base64 string của file âm thanh(.mp3 hoặc .wav).
"Type" : "Google",   là Loại âm thanh được tạo(Google :Giọng đọc google,FPT : Giọng đọc api của FPT,VBEE : Giọng đọc của api Vbee cung cấp,VTCC : Giọng đọc của Viettel, File : Tải file âm thanh dưới dạng base64 string.)
"VoiceType" : "",   là Kiểu giọng của loại âm thanh (
Google: Không cần truyền vào,
FPT: có 3 giọng đọc.{ male : Giọng Nam miền Bắc ,
female : Giọng Nữ miền Nam ,
hatieumai : Giọng Nữ miền Nam
},
VBEE: có 5 giọng đọc { hn_male_xuantin_vdts_48k-hsmm : Giọng nam Miền Bắc ,
hn_female_xuanthu_news_48k-hsmm : Giọng nữ Miền Bắc,
hn_female_thutrang_phrase_48k-hsmm : Giọng nữ Miền Bắc,
sg_male_xuankien_vdts_48k-hsmm : Giọng nam Miền Nam,
sg_female_xuanhong_vdts_48k-hsmm : Giọng nữ Miền Nam
},
VTCC : có 3 giọng đọc {
lethiyen-2018 : Giọng Lê Thị Yến - Miền Nam,
doanngocle2 : Giọng Đoàn Ngọc Lê - Miền Bắc,
trinhthiviettrinh : Giọng Trịnh Việt Trinh (Nữ miền Bắc)
}
).
"AudioName" : "xin chào buổi sáng",   là Tên định danh của âm thanh
}

Kết quả trả về:

{
"result": "success",
"message": "",
"data":  à Id của âm thanh vừa được tạo
}

Lấy danh sách file âm thanh

API: GetAudioList Method: POST Tham số truyền vào:

{

"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone

"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone

"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp

"Key" : "",   là Từ khóa cần tìm kiếm

"PageIndex" : 1,   là Trang hiện tại

"PageSize" : 20,   là Tổng số dòng trên trang

}

Kết quả trả về:

{

"result": "success",

"message": "",

"total": 232,

"data": [{

}]

}

Xóa file audio

API: Method: POST Tham số truyền vào:

{

"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone

"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone

"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp

" Id" : 12,   là Id của file âm thanh

}

Kết quả trả về:

{

"result": "success",

"message": ""

}

Contact

Thêm danh bạ

API: Method: POST Tham số truyền vào:

{

"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone

"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone

"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp

"Contact_Name":"tên định danh", là Tên định danh của số điện thoại

"First_Name":"", là Tên của chủ số điện thoại

"Last_Name":"", là Họ và tên lót

"Email_Address":"", là Địa chỉ Email

"Web_Site":"", là Website của chủ thể

"Department":"", là Chức vụ

"Company":"", là Công ty

"Address":"54 c1", là Địa chỉ

"Phone":"0988045786" là Số điện thoại

}

Kết quả trả về:

{

"result": "success",

"message": "",

"data":  à Contact Id của chủ thể

}

Thêm nhóm danh bạ

API: Method: POST Tham số truyền vào:

{

"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone

"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone

"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp

"ContactGroupName " : "",   là Tên của nhóm danh bạ

}

Kết quả trả về:

{

"result": "success",

"message": "",

"total": 232,

"data":  à ID của nhóm danh bạ

}

Thêm danh bạ vào nhóm danh bạ

API: Method: POST Tham số truyền vào:

{

"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone

"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone

"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp

"ContactGroupID" : "",   là ID của nhóm danh bạ muốn thêm danh bạ vào

"ContactId" : ["contactid","contactid"],   là Danh sách contactId

}

Kết quả trả về:

{

"result": "success",

"message": ""

}

Lấy danh sách nhóm danh bạ

API: Method: POST Tham số truyền vào:

{

"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone

"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone

"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp

"Key" : "",   là Từ khóa cần tìm kiếm

"PageIndex" : 1,   là Trang hiện tại

"PageSize" : 20,   là Tổng số dòng trên trang

}

Kết quả trả về:

{

"result": "success",

"message": "",

"total": 232,

"data": [{

}]

}

Lấy danh sách danh bạ trong nhóm danh bạ (chi tiết nhóm danh bạ)

API: Method: POST Tham số truyền vào:

{

"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone

"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone

"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp

"ContactGroupID" : "",   là ID nhóm danh bạ

"Key" : "",   là Từ khóa cần tìm kiếm

"PageIndex" : 1,   là Trang hiện tại

"PageSize" : 20,   là Tổng số dòng trên trang

}

Kết quả trả về:

{

"result": "success",

"message": "",

"total": 232,

"data": [{

}]

}

Lấy danh sách danh bạ

API: Method: POST Tham số truyền vào:

{

"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone

"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone

"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp

"Key" : "",   là Từ khóa cần tìm kiếm

"PageIndex" : 1,   là Trang hiện tại

"PageSize" : 20,   là Tổng số dòng trên trang

}

Kết quả trả về:

{

"result": "success",

"message": "",

"total": 232,

"data": [{

}]

}

Xóa danh bạ

API: Method: POST Tham số truyền vào:

{

"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone

"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone

"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp

"Contact_Id" : "",   là Contact_Id của danh bạ

}

Kết quả trả về:

{

"result": "success",

"message": ""

}

Xóa danh bạ khỏi nhóm danh bạ

API: Method: POST Tham số truyền vào:

{

"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone

"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone

"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp

"Contact_Id" : "",   là Contact_Id của danh bạ

"Group_Id" : ""   là Contact_Id của nhóm danh bạ

}

Kết quả trả về:

{

"result": "success",

"message": ""

}

Lấy danh sách báo cáo kết quả chạy chiến dịch

API: Method: POST Tham số truyền vào:

{

"ServiceCode" : "CF-XXXXX",  là Thông tin có khi mua dịch vụ CloudFone

"AuthUser" : "ODS1131",     là Thông tin User Của CloudFone

"AuthKey" : "fe8ae3db-19df-4edd-bd0d-5118ac62001b",   là Key CloudFone cung cấp

"ReportType" : 0,   là Loại kết quả cuộc gọi cần lấy (0: Tất cả,1: Gọi thành công,2: Không bắt máy, 3: KH bấm bận, 4: Người dùng chặn số, 5: Không thể kết nối đến số điện thoại)

"CampaignId" : "f39c616d-036c-4e12-ac18-1a0274bb9e07",  là Mã chiến dịch cần lấy báo cáo.

"PageIndex" : 1,  là Số thứ tự của trang lấy dữ liệu, mặc định là 1.

"PageSize ":20,  là Tổng số dòng hiển thị trên trang

"Key" : "key words to find",  là từ khóa tìm kiếm chiến dịch

}

Kết quả trả về:

{

"result": "success",

"message": "",

"total": 2262,  là tổng số kết quả đối với thông tin nhập bên trên.

"data": [{

}]

}

Chức năng gọi xác thực cuộc gọi

Tạo/cập nhật mẫu

API: CFAuthen/AddUpdateSameple Method: POST Tham số truyền vào:

{

"AuthUser":"ODS1268", => Mã KH

"AuthKey":"2b909f73069e47dba6feddb7c103eb98", => API Key

"SamepleId":"3c8e67de-ce25-406f-9549-4b09a97734f2", => Mã mẫu nếu rỗng là tạo,cập nhật thì truyền mã mẫu muốn cập nhật vào

"SamepleName":"test api 2", => tên mẫu

"Trunk":"", => Đầu số nếu có đầu số thì truyền vào,lấy từ api lấy danh sách đầu số api số 2, nếu KH không có đầu số thì để trống => sử dụng trunk của cloudfone

"FirstFile":"12", => id file.

"LastFile":"23", => id file.

"ServiceCode":"CF-BS0000XXX" => mã assistant

}

Kết quả trả về:

{

"result": "success",

"message": "Thêm mẫu thành công!",

"samepleId": "e8c56825-fa86-4cff-b7c3-2fbdaadc5e4a"

}

Lấy danh sách trunk(đầu số)

API: Method: POST Tham số truyền vào:

{

"AuthUser":"ODS6173",

"AuthKey":"e41108ee-f9e3-4075-904f-94d244ad7fc6",

"ServiceCode":"CF-AS00XXX"

}

Kết quả trả về:

{

"result": "success",

"message": "Lấy danh sách Trunk từ API thành công!",

"data": [

"CF-P000XXX",

"CF-BS0000XXX"

]

}

Bắt đầu cuộc gọi

API: Method: Post Tham số truyền vào:

{

"AuthUser":"ODS6173",

"AuthKey":"e41108ee-f9e3-4075-904f-94d244ad7fc6",

"Samepleid":"8e092f44-0bcf-42e6-bc24-c8f87b8482b4",

"Authencode":"0988045786",  => Mã xác thực là chuỗi số

"Phonenumber":"0988045786", => Số điện thoại cần gọi

"ServiceCode":"CF-AS000XXX"  => Mã assistant

}

Kết quả trả về:

{
"result": "success",
"message": "Gọi thành công!"
}

Xóa mẫu

API: http:// apiai.cloudfone.vn/api/CFAuthen/DeleteSameple Method: POST Tham số truyền vào:

{
"AuthUser":"ODS6173",
"AuthKey":"e41108ee-f9e3-4075-904f-94d244ad7fc6",
"ServiceCode":"CF-AS00XXX",
"Samepleid":"e8c56825-fa86-4cff-b7c3-2fbdaadc5e4a"
}

Kết quả trả về:

{
"result": "success",
"message": "Xóa mẫu e8c56825-fa86-4cff-b7c3-2fbdaadc5e4a từ API thành công!"
}