Docs/Menggunakan Plugin/AI Function Tool

AI Function Tool

Plugin Reminder dapat disediakan untuk AI agent Anda sebagai function yang bisa dipanggil. Jika diaktifkan, AI dapat menjadwalkan reminder secara mandiri selama percakapan, misalnya saat user meminta diingatkan tentang janji temu atau follow-up.

Cara Kerjanya

AI menerima function definition yang menjelaskan cara membuat reminder.
Saat maksud user membutuhkan reminder, AI memanggil function dengan detail penerima dan waktu kirim yang diinginkan.
Plugin memvalidasi panggilan terhadap secret konfigurasi dan membuat reminder item secara otomatis.
AI menerima response konfirmasi dan melanjutkan percakapan.

Mendapatkan Function Definition

Ambil skema function yang dapat dibaca AI untuk konfigurasi tertentu:

GET /api/reminder/ai/function-definition?agentId={agentId}&configurationId={configurationId}&secret={secret}

Response berisi JSON schema yang dipakai AI untuk memahami parameter function, termasuk nama field, tipe, dan deskripsinya. Daftarkan definition ini di pengaturan function tool agent Anda di CMS.

Endpoint AI Create Reminder

Saat AI memutuskan untuk membuat reminder, AI memanggil:

POST /api/reminder/ai/create-reminder?secret={secret}&configurationId={configurationId}

Request body:

Field	Tipe	Deskripsi
`userId`	string	Nomor telepon penerima (tanpa kode negara). Plugin memetakan nilai ini ke field `phoneNumber` milik reminder.
`message`	string	Isi pesan reminder. Disimpan sebagai parameter template pertama.
`sendTime`	datetime	Tanggal dan waktu tepat untuk mengirim reminder. Harus di masa depan.
`context`	string	Opsional. Konteks tambahan dari percakapan untuk logging.

Contoh request:

{
  "userId": "81234567890",
  "message": "Don't forget your appointment with Dr. Sari tomorrow at 09:00.",
  "sendTime": "2025-06-01T08:00:00",
  "context": "User asked for a reminder during appointment booking flow"
}

Autentikasi

AI harus mengirim Secret milik konfigurasi di query parameter secret. Ini adalah secret yang sama yang dibuat saat konfigurasi dibuat. Layanan Dialog menyimpan secret ini dan mengirimkannya secara otomatis saat memanggil function atas nama agent.

Jangan pernah menampilkan secret di kode sisi klien atau di log.

Aturan Validasi

Plugin menerapkan aturan berikut pada reminder yang dibuat oleh AI:

sendTime harus di masa depan. Reminder yang dijadwalkan di masa lalu akan ditolak.
userId harus berupa string yang tidak kosong.
message harus berupa string yang tidak kosong.
serverState milik konfigurasi harus running. Jika sedang paused, panggilan ditolak.

Pembuatan Nama Function

Anda dapat memakai AI untuk membuat nama function yang deskriptif berdasarkan tujuan plugin Anda. Ini membuat function mudah dikenali oleh model AI agent.

POST /api/reminder/configuration/generate-function-name

Request body:

{
  "description": "Schedule follow-up reminders for insurance renewal conversations"
}

Response:

{
  "functionName": "schedule_insurance_renewal_reminder"
}

Gunakan nama ini saat mendaftarkan function di pengaturan tool agent Anda.

Halaman Terkait

Plugin Setup: tempat kredensial Secret dibuat.
Create Reminder Items: pembuatan reminder secara manual.
Processing and Delivery: bagaimana reminder yang dibuat AI dikirim.
Reminder Overview

PreviousCreate Reminder Items

NextIntegration API