Kirim tugas panggilan
Kirim tugas panggilan
curl -X POST "https://api.example.com/open/v1/voice/notify/batch" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
"bulkId": "order-notify-20261110-001",
"messages": [
{
"taskName": "Shipping Notification - Example",
"scheduling": {
"type": "IMMEDIATE"
},
"templateId": "Tpl_0001",
"destinations": [
{
"to": "<PHONE>",
"variables": [
"John",
"A12345"
]
}
]
}
]
}'Envelope bisnis: 000000 diterima; data berisi bulkId/callId/acceptedCount; kode gagal skema enam digit platform
{
"code": "000000",
"data": {
"bulkId": "string",
"callId": "string",
"acceptedCount": 0
},
"message": "success"
}Contoh respons dari kontrak yang ditinjau, bukan hasil permintaan nyata.
Lakukan panggilan notifikasi suara (TTS) ke satu atau beberapa penerima. Autentikasi Bearer; negara panggilan diturunkan dari template; waktu terjadwal ISO 8601 dengan zona waktu; kode error skema enam digit platform. Pengiriman dapat melakukan panggilan nyata dan menimbulkan biaya.
Gunakan AppKey InnoPaaS sebagai Bearer token. Buat atau kelola key di halaman API keys Console. Panduan API key
Authorization
Authorizationstring<bearer>wajibBody
application/jsonbulkIdstringopsionalID permintaan kustom, di-echo untuk rekonsiliasi (bukan kunci idempoten)
64messagesarray<object>wajibDaftar pesan, saat ini hanya satu per permintaan
Tampilkan atribut anak
fromstringopsionalNomor pengirim (E.164); kosongkan untuk rute default negara, harus nomor terikat bila diisi
retryobjectopsionalKebijakan panggil ulang; default 1x / 60 menit / panggil ulang saat tak tersambung & tak dijawab
Tampilkan atribut anak
maxCountintegeropsional1Minimum0Maksimum3noAnswerbooleanopsionalPanggil ulang saat tidak dijawab, default true
truenoConnectedbooleanopsionalPanggil ulang saat tak dapat tersambung, default true
trueintervalMinutesintegeropsional60Minimum1Maksimum360taskNamestringopsionalNama tugas; dibuat server bila kosong
50hangupSmsobjectopsionalSMS hang-up; kehadiran objek mengaktifkannya, hapus bila tidak perlu
Tampilkan atribut anak
sendTypestringopsionalON_CONNECTED kirim setelah tersambung (default); ALL semua; ON_UNANSWERED tak tersambung; BY_DURATION menurut durasi
ON_CONNECTEDtemplateIdstringwajibID template SMS hang-up (wajib saat diaktifkan)
durationLimitSecondsintegeropsionalAmbang durasi tersambung (detik), wajib untuk BY_DURATION
1playTimesintegeropsionalJumlah pemutaran; default dari konfigurasi template (lalu 1)
1Maksimum3schedulingobjectopsionalPenjadwalan pengiriman; default kirim langsung
Tampilkan atribut anak
typestringopsionalIMMEDIATE langsung (default); SCHEDULED terjadwal (wajib start/end)
endTimestringopsionalAkhir jendela terjadwal, harus setelah startTime
startTimestringopsionalAwal jendela terjadwal, ISO 8601 dengan zona waktu; harus di masa depan; jendela ≤8 hari
templateIdstringwajibID template suara yang telah disetujui; negara panggilan diturunkan dari template
destinationsarray<object>wajibDaftar tujuan penerima, 1-1000
Tampilkan atribut anak
tostringwajibNomor penerima (E.164 dengan kode negara, 6-20 digit)
^\d{6,20}$variablesarray<string>opsionalNilai variabel template, sesuai urutan placeholder {1}…{n}; hapus untuk template tanpa variabel
Respons
application/jsonEnvelope bisnis: 000000 diterima; data berisi bulkId/callId/acceptedCount; kode gagal skema enam digit platform
codestringopsionaldataobjectnullopsionalmessagestringopsional{
"code": "000000",
"data": {
"bulkId": "string",
"callId": "string",
"acceptedCount": 0
},
"message": "success"
}Contoh respons dari kontrak yang ditinjau, bukan hasil permintaan nyata.