Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- Connect
- Pengaturan Dokumentasi
- KONEKSI API
- pengantar
- pengantar
- Autentikasi
- URL dasar
- Sub-sumber daya
- OTP suara
- Perpesanan
- MNP
- Koneksi API
- pengantar
- API Connect memungkinkan Anda menggunakan layanan telekomunikasi yang disediakan oleh CMC Telecom.
- Autentikasi
- API terhubung menggunakan otentikasi dasar untuk mengautentikasi setiap Permintaan API dengan App IDdan App Secretdisediakan oleh CMC Telecom. Jika token Authe tidak valid, server akan merespons dengan 401status. Contoh:
- {
- "code": 401,
- "message": "Authorization Required",
- "errors":""
- }
- URL dasar
- Production URL: https://api-connect.io
- Development URL: https://dev.api-connect.io
- Koneksi API dilayani melalui HTTPS. Untuk memastikan privasi data, HTTP tidak terenkripsi tidak didukung.
- Sub-sumber daya
- Koneksi API memiliki sub-sumber daya berikut. Klik tautan untuk informasi detail masing-masing sumber daya
- Suara-OTP
- Mengirim panggilan Suara-OTP
- Ambil daftar suara
- Tetapkan suara default
- OTP suara
- Mengizinkan Anda mengirim panggilan suara-otp, mengambil daftar suara, mengatur suara default untuk panggilan suara-otp
- DAPATKANAmbil daftar suara
- BASE_URL/suara-otp/suara
- Dapatkan daftar suara untuk dipilih pengguna
- Anda dapat mengambil suara Anda yang tersedia. informasi rinci dari bidang:
- Bidang Jenis Keterangan
- Indo rangkaian Ini adalah voiceId saat melakukan panggilan otp suara
- nama rangkaian Nama suara
- keterangan rangkaian Informasi rinci tentang suara
- isDefault boolean jika benar , sistem akan menggunakan id suara untuk melakukan panggilan otp suara
- aktif boolean Status suara. Jika salah , sistem tidak akan digunakan untuk melakukan panggilan otp suara
- orgId rangkaian id organisasi Anda di sistem CMC Telecom
- KEPALA
- Jenis konten
- aplikasi/json
- Otorisasi
- Dasar < Base64 disandikan "app-id" dan "app-secret" >
- Contoh Permintaan
- Ambil daftar suara
- GET /voice-otp/voice HTTP/1.1
- Host: api-connect.io
- Authorization: Basic <Base64 encoded "app-id" and "app-secret">
- Contoh Tanggapan
- Tubuh
- Tajuk
- (0)
- Lihat Lebih Banyak
- [
- {
- "id": "giong-nu",
- "name": "Giong nu",
- "description": "system",
- "voiceType": "system",
- "isDefault": false,
- "isActive": true,
- "orgId": "5cfc8bee087e5f035b2cbabf",
- "createdBy": {
- "userId": "5eb4c4967a647222d551b7ce",
- POSTetapkan suara default
- BASE_URL/voice-otp/voice/set-default/{voiceId}
- Anda dapat mengatur suara default saat mengirim panggilan otp. Jika suara diatur, Anda TIDAK perlu mengirimkan voiceIddata API voice-otp di sini
- KEPALA
- Jenis konten
- aplikasi/json
- Otorisasi
- Dasar < Base64 disandikan "app-id" dan "app-secret" >
- Contoh Permintaan
- Tetapkan suara default
- POST /voice-otp/voice/set-default/{voiceId} HTTP/1.1
- Host: api-connect.io
- Content-type: application/json
- Authorization: Basic <Base64 encoded "app-id" and "app-secret">
- POSKirim panggilan suara-otp
- BASE_URL/suara-otp/suara-otp
- Untuk mengirim panggilan Voice OTP untuk pelanggan, sistem mitra harus terhubung dengan Voice-OTP dari CMC Telecom
- Atribut yang tersedia dan kondisi di mana mereka diperlukan adalah:
- Lihat Lebih Banyak
- Bidang Jenis Keterangan Yg dibutuhkan
- dari rangkaian Nomor telepon melakukan panggilan pemberitahuan OTP Ya
- ke rangkaian Nomor telepon menerima panggilan pemberitahuan OTP Ya
- otp obyek Kode OTP akan dikirimkan ke pengguna. Kode OTP pengguna dienkripsi oleh AES 256 CBC bersama dengan IV. Kunci Terenkripsi disetujui antara CMC dan sistem mitra Ya
- otp.encrypted rangkaian kode otp dienkripsi. Ya
- otp.algorithm rangkaian menggunakan aes-256-cbc. Ya
- otp.iv rangkaian IV digunakan untuk dienkripsi Ya
- voiceId rangkaian suara. Contoh: 'giong-nu'. Jika voiceId tidak diatur, sistem akan mendapatkan voiceId default dari pengguna atau sistem Tidak
- ulang boolean Jika benar , kode otp akan berulang 2 kali, salah satu kali Tidak
- KEPALA
- Jenis konten
- aplikasi/json
- Otorisasi
- Dasar < Base64 disandikan "app-id" dan "app-secret" >
- TUBUH mentah
- Lihat Lebih Banyak
- {
- "from":"02471060033",
- "to":"09775705345",
- "otp":{
- "encrypted":"AB6B2B941C662F46DA0392610D7F91C3",
- "algorithm": "aes-256-cbc",
- "iv":"0000000000000000"
- },
- "voiceId": "giong-nu",
- "repeat":true
- }
- Contoh Permintaan
- 200 - Terima kasih
- Lihat Lebih Banyak
- POST /voice-otp/voice-otp HTTP/1.1
- Host: api-connect.io
- Authorization: Basic <Base64 encoded "app-id" and "app-secret">
- Content-Type: application/json
- Content-Length: 185
- {
- "from":"02471060033",
- "to":"0977570592",
- "otp":{
- "encrypted":"283CF28529F6C318218E5591CC7036D8",
- Contoh Tanggapan
- 200 oke
- Tubuh
- Tajuk
- (15)
- Lihat Lebih Banyak
- {
- "id": "5d2d2b930a90818f93402ef0",
- "from": "02471060008",
- "to": "0912205468",
- "otp": {
- "encrypted": "c2ce21e5f023c9f6d7b807a709091468",
- "algorithm": "aes-256-cbc"
- },
- "blocks": 1,
- "status": "answered",
- "createdAt": "2019-07-16T01:42:43.827Z"
- POSWebhook untuk acara Voice-OTP
- URL API Pelanggan
- Pelanggan perlu membuat API untuk menerima acara saat status Voice-OTP berubah. Sistem Voice-OTP CMC Telecom akan melakukan POSTpermintaan ke pelanggan API
- Melewati parameter di badan dalam format JSON:
- Lihat Lebih Banyak
- Bidang Jenis Keterangan Yg dibutuhkan
- Indo rangkaian ID OTP Suara
- status rangkaian Status OTP suara mencakup:
- - gagal : Sistem gagal melakukan panggilan.
- - jawab : Pengguna menerima panggilan, menjawab dan mendengarkan konten.
- - sibuk : Pengguna menolak panggilan, atau pengguna sedang dalam panggilan lain.
- - no-answered : Pengguna tidak menerima panggilan, telepon mati atau berada di luar area jangkauan
- durasi nomor Waktu untuk melakukan panggilan. Satuan: detik (s)
- memblokir nomor Nomor blok sesuai dengan aturan metode perhitungan kontrak
- KEPALA
- Jenis konten
- aplikasi/json
- TUBUH mentah
- {
- "id": "5be4c210fcbcecd0c2f24516",
- "status": "answered",
- "duration":9,
- "block": 1
- }
- Contoh Permintaan
- Webhook untuk acara Voice-OTP
- Lihat Lebih Banyak
- POST / HTTP/1.1
- Host: URL API of Customer
- Content-Type: application/json
- Content-Length: 100
- {
- "id": "5be4c210fcbcecd0c2f24516",
- "status": "answered",
- "duration":9,
- "block": 1
- }
- DAPATKANAmbil CDR (catatan detail panggilan)
- BASE_URL/voice-otp/voice-otp?filter={"where":{"and":[{"status":"pending"},{"from":1593767524},{"to": 1594026724}]} ,"lewati":0,"batas":40}
- KEPALA
- Otorisasi
- Dasar < Base64 disandikan "app-id" dan "app-secret" >
- PARAMS
- Saring
- {"where":{"and":[{"status":"pending"},{"from":1593767524},{"to": 1594026724}]},"skip":0,"limit":40 }
- bidang dari adalah waktu mulai klausa kueri, bidang ke adalah waktu akhir klausa kueri - menggunakan format stempel waktu GMT . Contoh: 1594030703 setara Sen, 06 Juli 2020 10:18:23 GMT
- status adalah status panggilan dalam klausa kueri
- lewati Jumlah item yang akan dilewati.
- limit Jumlah item yang akan dipilih.
- Contoh Permintaan
- Ambil CDR (catatan detail panggilan)
- GET /voice-otp/voice-otp?filter={"where":{"and":[{"status":"pending"},{"from":1593767524},{"to": 1594026724}]},"skip":0,"limit":40} HTTP/1.1
- Host: api-connect.io
- Authorization: Basic <Base64 encoded "app-id" and "app-secret">
- Perpesanan
- SMS
- POSKirim SMS Tunggal
- {{BASE_URL}}/messaging/sms
- Untuk mengirim Single SMS ke pelanggan, sistem mitra harus terhubung dengan API SMS dari CMC Telecom
- API yang menggunakan POSTmetode dengan payload adalah JSON Body. Parameter yang tersedia dan ketentuan dalam JSON Body adalah di bawah ini:
- Lihat Lebih Banyak
- Bidang Jenis Keterangan Yg dibutuhkan
- dari rangkaian Pengirim terdaftar yang digunakan untuk mengirim SMS. Setiap arah pengiriman akan menggunakan nilai yang berbeda Ya
- ke rangkaian Nomor ponsel menerima SMS Ya
- tubuh string/objek Isi SMS yang akan dikirim. Menggunakan tipe objek untuk menentukan nilai saat mengirim ke ZALO Ya
- templateId rangkaian TemplateId berhasil didaftarkan dengan Zalo Tidak
- OTORISASI
- Autentikasi Dasar
- Nama belakang
- <nama pengguna>
- Kata sandi
- <kata sandi>
- KEPALA
- Jenis konten
- aplikasi/json
- TUBUH mentah
- {
- "from":"CMC Telecom",
- "to":"0977XXXXX",
- "body":"SMS from CMC Telecom"
- }
- Kirim SMS Tunggal
- Contoh Permintaan
- Lihat Lebih Banyak
- POST /messaging/sms HTTP/1.1
- Host: {{BASE_URL}}
- Content-Type: application/json
- Content-Length: 76
- {
- "from":"CMC Telecom",
- "to":"0977XXXXX",
- "body":"SMS from CMC Telecom"
- }
- Contoh Tanggapan
- 200 oke
- Tubuh
- Tajuk
- (0)
- Lihat Lebih Banyak
- {
- "id": "603722d645fe090007a6bdbb",
- "msgId": "",
- "from": "CMC Zalo",
- "to": "84977570592",
- "body": "Body content",
- "createdAt": "2021-02-25T04:08:54.471Z",
- "status": "queued",
- "isUnicode": false,
- "characters": 12,
- "parts": 1,
- POSTerima pengait Status SMS
- {{CUSTOMER_URL}}
- TUBUH mentah
- {
- "id":"612261bb7cf5dd0014a03908",
- "status":"sent",
- "detail": "",
- "sentAt": "2021-08-04T08:13:12.973Z"
- }
- Contoh Permintaan
- Terima pengait Status SMS
- Lihat Lebih Banyak
- POST / HTTP/1.1
- Host: {{CUSTOMER_URL}}
- Content-Length: 120
- {
- "id":"612261bb7cf5dd0014a03908",
- "status":"sent",
- "detail": "",
- "sentAt": "2021-08-04T08:13:12.973Z"
- }
- DAPATKANDapatkan Detail SMS
- {{BASE_URL}}/messaging/sms/{:id}
- status
- tertunda: chờ gửi
- diterbitkan: đã phân bổ để gửi
- antri: tin nằm trong hàng đợi chờ gửi
- terkirim: đã gửi
- gagal: gửi thất bại
- OTORISASI
- Autentikasi Dasar
- Nama belakang
- <nama pengguna>
- Kata sandi
- <kata sandi>
- KEPALA
- Jenis konten
- aplikasi/json
- Contoh Permintaan
- Dapatkan Status SMS
- GET /messaging/sms/5d715c6d10824a5a6e4afe1d HTTP/1.1
- Host: api-connect.io
- Content-Type: application/json
- Contoh Tanggapan
- 200 oke
- Tubuh
- Tajuk
- (15)
- Lihat Lebih Banyak
- {
- "id": "5d715c6d10824a5a6e4afe1d",
- "msgId": "",
- "from": "CMC Telecom",
- "to": "0912205468",
- "body": "CMC TEST SMS",
- "createdAt": "2019-09-05T19:05:17.698Z",
- "sentAt": "2019-09-05T19:05:23.852Z",
- "status": "sent",
- "isUnicode": false,
- "characters": 12,
- MNP
- DAPATKANDapatkan Penyedia
- https://dev.api-connect.io/mnp-int/mnp/get-provider?filter={"phoneNumber": ""}
- Dapatkan penyedia nomor telepon
- Informasi filter terperinci dari bidang:
- Bidang Jenis Keterangan
- nomor telepon rangkaian nomor telepon, yang digunakan untuk mencari tahu
- Hasil: kode penyedia dengan tipe string
- KEPALA
- Otorisasi
- UslVZ9h5SZ0ZCFdDaBr1dgqWEAfwqLCun73dQaX1jyCAUmfNzDs67LIOcGy3ECh2
- Jenis konten
- aplikasi/json
- PARAMS
- Saring
- {"nomor telepon": ""}
- Contoh Permintaan
- 200 - Terima kasih
- GET /voice-otp/voice-otp/5d2d2b930a90818f93402ef0 HTTP/1.1
- Host: api-connect.io
- Authorization: Basic <Base64 encoded "app-id" and "app-secret">
- Content-Type: application/json
- Contoh Tanggapan
- 200 oke
- Tubuh
- Tajuk
- (15)
- Lihat Lebih Banyak
- {
- "from": "02471060008",
- "to": "0912205468",
- "otp": {
- "encrypted": "c2ce21e5f023c9f6d7b807a709091468",
- "algorithm": "aes-256-cbc"
- },
- "blocks": 1,
- "status": "answered",
- "createdAt": "2019-07-16T01:42:43.827Z",
- "id": "5d2d2b930a90818f93402ef0"
