Referensi node urutan suara

Peringatan: Urutan suara masih dalam tahap pratinjau. Langkah, data entry, dan format definisi urutan dapat berubah sehingga merusak urutan dan permintaan API yang sudah ada.

Gunakan referensi ini untuk menulis sequence.definition yang Anda kirim dengan Buat Panggilan. Bird menjalankan definisi inline sekali dan tidak menyimpannya. Untuk menyimpan urutan, buat di editor dasbor.

Definisi

Setiap node memiliki field berikut:

Koneksi tidak boleh membentuk loop, dan setiap node harus dapat dijangkau dari entry. Outcome yang tidak ada di connections dianggap tidak terhubung. Outcome yang tidak terhubung mengakhiri eksekusi secara normal, kecuali jika node menentukan sebaliknya.

Nilai dan ekspresi

Sebagian besar field menerima JSON literal. Field bertanda binds juga menerima $expr atau $template; field bertanda expr hanya menerima $expr:

• {"$expr": "trigger.data.customer_name"} mengembalikan nilai bertipe.
• {"$template": ["Hello ", {"$expr": "trigger.data.customer_name"}, "."]} mengembalikan teks. Template berupa array; {{name}} tetap berupa teks literal.

Ekspresi menggunakan CEL dan dapat membaca nilai berikut:

Periksa nilai opsional sebelum membacanya, misalnya has(trigger.data.name) ? trigger.data.name : 'caller'. Makro has tersedia; map, filter, all, exists, dan exists_one tidak tersedia.

Entry

trigger.start_call

Tempat panggilan dimulai. entry_node_id dalam permintaan Create Call menamai node ini.

Data entry dibatasi hingga 16 KiB.

Ucapan dan audio

voice.say

voice.play

voice.tone

logic.pause

Menunggu dengan panggilan tetap terhubung.

Input keypad

voice.gather

Memutar prompt, yang dapat diinterupsi oleh penekanan tombol, dan mengumpulkan digit keypad.

Logika dan data

logic.branch

Memeriksa kondisi secara berurutan dan mengikuti kondisi pertama yang bernilai benar.

data.set

Menyimpan nilai untuk langkah-langkah selanjutnya dalam kunjungan yang sama.

Panggilan dan transfer

voice.dial

Menelepon nomor telepon atau nomor pada salah satu trunk SIP masuk di workspace Anda, atau membunyikan ring group, lalu menghubungkannya ke panggilan saat ini. Gunakan type_version 3.

Versi 2 tidak memiliki target ring_group dan selalu mewajibkan timeout_seconds. Setiap input versi 2 juga valid di versi 3, sehingga meningkatkan versi langkah tidak mengubah hal lain.

Versi 1 menerima nomor di input.to dan tidak memiliki orig. Langkah yang menggunakannya tetap berjalan. Saat Anda meningkatkan langkah versi 1 di editor, nilai to-nya dipindahkan ke pstn.dest.

logic.voice_goto

Memulai entry lain dalam definisi yang sama. Kunjungan baru mendapatkan trigger.data baru dan menghapus output serta variabel dari langkah sebelumnya; panggilan tetap berlanjut.

Automations

automation.send_event

Mengirim event aplikasi ke Automation tanpa menunggu eksekusi. Panggilan berlanjut setelah event masuk antrean; apakah eksekusi dimulai hanya terlihat di Automations.

Mengakhiri panggilan

logic.exit

Mengakhiri panggilan dengan hasil.

voice.hangup

Mengakhiri panggilan tanpa hasil yang ditulis. Node ini tidak memiliki field maupun outcome.

Lihat Menggunakan data aplikasi dalam urutan suara untuk voice.webhook.

Contoh: transfer ke seseorang

Definisi ini menyapa penerima, menghubungi nomor dukungan, dan mencatat apakah transfer berhasil tersambung:

{
  "schema_version": 1,
  "expression_environment": "bird.cel.v1",
  "nodes": [
    {
      "id": "start",
      "type": "trigger.start_call",
      "type_version": 1,
      "config": {},
      "input": {},
      "connections": { "event": { "node_id": "greeting", "port": "input" } }
    },
    {
      "id": "greeting",
      "type": "voice.say",
      "type_version": 1,
      "config": {},
      "input": { "text": "Connecting you to our support team.", "language": "en" },
      "connections": { "next": { "node_id": "support", "port": "input" } }
    },
    {
      "id": "support",
      "type": "voice.dial",
      "type_version": 3,
      "config": {},
      "input": { "type": "pstn", "pstn": { "dest": "+12025550123" }, "timeout_seconds": 30 },
      "connections": {
        "success": { "node_id": "connected", "port": "input" },
        "busy": { "node_id": "unavailable", "port": "input" },
        "no_answer": { "node_id": "unavailable", "port": "input" },
        "failure": { "node_id": "unavailable", "port": "input" }
      }
    },
    {
      "id": "connected",
      "type": "logic.exit",
      "type_version": 1,
      "config": { "status": "succeeded", "reason": "transferred" },
      "input": { "output": {} }
    },
    {
      "id": "unavailable",
      "type": "logic.exit",
      "type_version": 1,
      "config": { "status": "failed", "reason": "support_unavailable" },
      "input": { "output": {} }
    }
  ]
}

Kirim sebagai sequence.definition dengan "entry_node_id": "start" dan "trigger_data": {}.