This page has been moved to MiiTel Developers. Please see "JavaScript Widget" page.
Note that this page will not be updated in the future.
Fitur ini memungkinkan Anda embed MiiTel Phone ke aplikasi web eksternal. (Customer relationship management system (CRM), reservation management system, ordering system, inventory management system, dll.)
Selain itu, penyedia aplikasi SaaS dapat menyediakan fitur ini kepada pelanggan yang menggunakan MiiTel.
Konten
- Menerima kode embed
- Menyesuaikan widgett
- Sisipkan fungsi callback untuk incoming calls
- Make a call dan register outgoing nomor telepon ke Contacts
- End the call
- Tambahkan fungsi panggilan balik untuk menentukan apakah pengguna tersedia untuk melakukan panggilan
- Tambahkan fungsi panggilan balik yang mengembalikan sequence ID
- Tambahkan fungsi panggilan balik yang memberi tahu saat panggilan dimulai
- Tambahkan fungsi panggilan balik yang memberi tahu saat panggilan dimulai
- Tambahkan fungsi panggilan balik yang memberi tahu saat panggilan berakhir
- Sesuaikan posisi tampilan
- Sesuaikan warna
- Ubah gambar tombol aktivasi widget
- Ubah gambar logo
- Contoh code (HTML)
PENTING
- Isi halaman ini adalah untuk engineer yang mengembangkan aplikasi. Untuk mengimplementasikan widget, engineer aplikasi web perlu melakukan tugas yang dijelaskan di sini halaman (tidak tersedia untuk pengguna aplikasi web).
- Jika Anda embed widget JavaScript ke aplikasi web yang bukan SPA (single-page application)), panggilan mungkin terputus karena perubahan layar selama panggilan.
Terima embed code
- Log in ke MiiTel Admin.
-
Klik Third Party Integration > Javascript Widget.
-
Masukkan kode HTML (seperti yang terlihat pada gambar di bawah) ke
<body>
or<head>
tag dari HTML dalam aplikasi web.
-
Setelah Anda memasukkan kode, Miitel Phone akan diatur di kanan bawah bagian dari halaman.
- Setelah Anda mengklik MiiTel Phone, softphone akan ditampilkan.
Customize widget
Dengan menambahkan kode berikut, Anda akan dapat menambahkan events incoming atau outgoing calls atau mengubah tampilan dan nuansa.
Sisipkan fungsi callback untuk incoming calls
Dengan metode miitelWidget.call("onReceiveCall", [callback function])
, Anda bisa jalankan fungsi callback yang ditentukan untuk incoming call.
Incoming event parameter
phoneNumber: Caller's phone number (for internal calls: extension number)
groupName: Name of the group that received the call
circuitTitle: Circuit title of the phone number
circuitNumber: Phone number of the person who will receive the call
userName: User name of the person who receives the call
isInternal: Internal calls or not
isTransfer: Internal transfer or not
remotePhoneNumber: A phone number that is transferred (internal transfers only)
Contoh imlplementasi
function receiveCall(e) {
if (e.isInternal && !e.isTransfer) {
let text = "Internal call\n";
text += "From: " + e.phoneNumber; + "\n";
text += "Calling for " + e.userName + " \n";
alert(text);
} else if (e.isTransfer) {
let text = "Internal transfer\n";
text += "From: " + e.phoneNumber; + "\n";
text += "Transferred phone number: " + e.remotePhoneNumber + " \n";
alert(text);
} else if (e.groupName !== "" ) {
let text = "To group\n";
text += "From: " + e.phoneNumber;
text += "To: " + e.circuitNumber + "\n";
text += "Circuit tile: " + e.circuitTitle + "\n";
text += "Calling for " + e.groupName + " \n";
alert(text);
} else {
let text = "To user\n";
text += "From: " + e.phoneNumber; + "\n";
text += "To: "e.circuitNumber + " \n";
text += "Circuit tile: " + e.circuitTitle + "\n";
text += "Calling for " + e.userNmae + "\n";
alert(text);
}
}
miitelWidget("onReceiveCall", receiveCall);
Membuat penelponan dan mendaftarkan nomor outgoing call ke contact
Dengan miitelWidget.call()
Metode, Anda dapat melakukan panggilan telepon ke nomor telepon yang Anda pilih dari softphone.
Anda dapat menggabungkan metode ini dengan Klik
event untuk melakukan click to call.
Juga, jika Anda menambahkan parameter, Anda dapat mendaftarkan nomor telepon keluar Contacts.
Contoh implementasi
// Membuat outgoing call
miitelWidget.call("09012345678");
// Daftarkan informasi kontak saat Anda membuatoutgoing call
miitelWidget.call("09012345678", {
contact: {
companyName: "Account name",
contactPersonName: "Contact person name"
}
});
parameter Outgoing call
phoneNumber
: Penerima nomor telepon (wajib)companyName
: Account nama (ketika Anda akan mendaftarkan nomor telepon penerima ke Contacts)contactPersonName
: Nama orang yang dapat dihubungi (Jika Anda ingin mendaftarkan nomor telepon penerima ke Kontak)
PENTING
- Set phoneNumber with half-width digits.
- JIka companyName or contactPersonName is blank, nomor telepon penerima tidak akan didaftarkan Contact.
- Jika full-width space pada companyName, kontak Anda akan terdaftar sebagai Unknown company.
- Jika full-width space pada companyPersonName, kontak Anda akan didaftarkan sebagai Unknown contact. Jika nomor telepon sudah terdaftar di Kontak, account name dan nama contact person akan ditimpa.
Mengakhiri panggilan
Dengan metode miitelWidget.hangup();
, Anda dapat mengakhiri panggilan telepon berikut.
- Softphone yang sedang melakukan panggilan.
- Softphone yang sedang menerima panggilan.
- Softphone yang sedang ditelepon.
Anda dapat mengkombinasikan dengan onClick
event atau event lainnya untuk mengakhiri panggilan yang sedang berlangsung atau panggilan yang dibuat atau menerima panggilan tersebut.
Implementation example
// End ongoing calls or calls that are making or receiving the call.
miitelWidget.hangup();
Tambahkan fungsi callback untuk menentukan apakah pengguna tersedia untuk melakukan panggilan
Jika status ketersediaan untuk melakukan panggilan diubah dari miitelWidget("onChangeReadyState", [callback function])
metode, fungsi callback yang ditentukan akan diimplementasikan.
Anda dapat menggunakan kode untuk menonaktifkan tombol klik untuk menelepon saat pengguna tidak bisa melakukan panggilan, seperti jika dia keluar atau sedang melakukan panggilan lain.
Contoh implementasi
function updateReadyState(e){
if(e.state){
alert("Outbound call feature has been enabled.")
} else{
alert("Outbound call feature has been enabled.")
}
}
miitelWidget("onChangeReadyState", updateReadyState);
Tambahkan fungsi callback yang mengembalikan sequence ID
miitelWidget("onReceiveSequenceId", [callback function])
metode mengimplementasikan fungsi callback ketika sequence ID (ID yang mengidentifikasi masing-masing panggilan) diterima setelah panggilan dimulai. ID urutan dapat digunakan untuk secara langsung rujuk halaman call history individual di MiiTel Analytics. URL untuk ini akan https://<Company ID>.miitel.jp/app/calls/<Sequence ID>
.
Contoh implementasi
function receiveSequenceId(e){
document.write("URL is https://<company ID>.miitel.jp/app/calls/"+ e.sequenceId)
}
miitelWidget("onReceiveSequenceId", receiveSequenceId);
Tambahkan fungsi callback yang memberi tahu saat panggilan dimulai
Jika Anda menggunakan miitelWidget("onDialBegin", [callback function])
metode, fungsi callback akan diimplementasikan saat Anda mulai melakukan panggilan atau saat Anda menerima incoming call.
Contoh implementasi
function dialBegin(e){
document.write("Dial begin")
}
miitelWidget("onDialBegin", dialBegin);
Tambahkan fungsi callback yang memberi tahu saat panggilan dimulai
Jika Anda menggunakan miitelWidget("onCallBegin", [callback function])
metode, fungsi callback akan diimplementasikan saat orang lain mengambilnya panggilan (untuk outgoing calls) atau saat Anda menekanAnswer dari incoming call.
Conoth implememtasi
function callBegin(e){
document.write("Call begin")
}
miitelWidget("onCallBegin", callBegin);
Tambahkan fungsi callback yang memberi tahu saat panggilan berakhir
Jika Anda menggunakan miitelWidget("onCallEnd", [callback function])
method, fungsi callback akan diimplementasikan saat panggilan selesai.
Contoh implementasi
function callEnd(e){
document.write("Call end")
}
miitelWidget("onCallEnd", callEnd);
Sesuaikan posisi tampilan
Anda dapat menyesuaikan posisi tampilan tombol dan keypad dengan miitelWidget("position", [location])
metode. Jika Anda tidak dapat mengubah pengaturan, posisi default akan right_bottom
(bottom right).
Value yang dapat Anda tetapkan adalah left_bottom
(bottom left) and right_bottom
(bottom right).
Contoh Implementasi
miitelWidget("position", "left_bottom");
Kustomisasi warna
Anda dapat kustomisasi warna dengan miitelWidget("color", [color])
metode. Jika Anda tidak dapat mengubah pengaturan, warna default akan menjadi black
(black theme).
value yang dapat Anda tetapkan adalah white
(white theme) and black
(black theme).
Contoh implementasi
miitelWidget("color", "white");
Ubah gambar tombol aktivasi widget
Anda dapat mengubah gambar tombol aktivasi widget dengan miitelWidget("openButtonImage", [Picture URL])
method.
Kami merekomendasikan menggunakan image dengan format SVG dan 180 x 30 px. Untuk URL, Anda perlu menentukan URL yang dimulai dengan https://
.
Contoh implementasi
miitelWidget("openButtonImage", "https://yourwebsite.com/button.svg");
Change the picture of the logo
miitelWidget("logoImage", [Picture URL])
metode akan memungkinkan Anda untuk mengubah gambar logo Anda.
Kami merekomendasikan menggunakan image dengan format SVG dan 180 x 30 px. Untuk URL, Anda perlu menentukan URL yang dimulai dengan https://
.
Contoh implementasi
miitelWidget("logoImage", "https://yourwebsite.com/logo.svg");
PENTING
- Javascript widgets tidak bisa dimasukkan ke dalam HTTP sites. Silakan coba HTTPS sites atau localhost.
Sample code (HTML)
Kami memiliki sample codes yang tersedia sebagai panduan Anda.