Chatbot API

Endpoint ini digunakan untuk mengirim pesan ke chatbot dan menerima respons darinya.

Send Message

POST /api/external/chatbot/send-message

Mengirim pertanyaan atau pesan ke chatbot dan menerima respons berdasarkan konteks yang diberikan.

Contoh Permintaan

Deskripsi: Bagian ini memberikan contoh bagaimana format permintaan HTTP harus dibuat untuk mengirim pesan ke chatbot.

POST /api/external/chatbot/send-message HTTP/1.1
Host: api.majadigidev.jatimprov.go.id
Content-Type: application/json

{
    "question": "ada layanan apa di majadigi?",
    "additional_context": "",
    "session_id": "12"
}

Parameter Body

Deskripsi: Tabel ini menjelaskan parameter yang harus disertakan dalam body permintaan untuk berinteraksi dengan chatbot.

Nama

Tipe

Deskripsi

Batasan

question

string

Pertanyaan atau pesan yang diajukan kepada chatbot.

Maksimum 1000 karakter

additional_context

string

Konteks tambahan yang dapat membantu chatbot dalam memberikan respons.

Maksimum 2000 karakter

session_id

string

ID sesi untuk melacak percakapan dengan chatbot.

Maksimum 100 karakter

Respons

Deskripsi: Bagian ini menunjukkan format respons yang akan diterima dari chatbot setelah mengirim pesan.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": {
        "message": [
            {
                "text": "Majadigi menyediakan berbagai layanan yang dikelompokkan berdasarkan kategori. Beberapa layanan yang tersedia di Majadigi antara lain:\n\n1. **Layanan Sosial**: Menyediakan informasi dan layanan sosial yang berfokus pada kesejahteraan masyarakat. Namun, saat ini layanan ini belum tersedia.\n\n2. **Layanan Lingkungan Hidup**: Menyediakan informasi dan pelayanan pengelolaan lingkungan yang berkelanjutan. Saat ini juga belum tersedia.\n\n3. **Layanan Kabupaten & Kota**: Menyediakan layanan yang mendukung administrasi Kabupaten & Kota. Salah satu contoh adalah **Smart Kampung Banyuwangi**, yang merupakan aplikasi untuk warga Banyuwangi.\n\n4. **Layanan Ekonomi dan Bisnis**: Menyediakan beragam informasi dan layanan yang disesuaikan dengan kebutuhan warga Jawa Timur. Salah satu contohnya adalah **Rumah ASN**, yang menjawab keluhan ASN dan masyarakat umum seputar kepegawaian.\n\n<br>",
                "properties": {
                    "source": {
                        "id": "OpenAIModel-b1JlZ",
                        "display_name": "OpenAI",
                        "source": "gpt-4o-mini"
                    },
                    "icon": "OpenAI",
                    "allow_markdown": false,
                    "state": "complete",
                    "text_color": "",
                    "background_color": ""
                },
                "category": "message",
                "id": "1ba0d94b-4144-4f3c-a877-f19d2e08d867",
                "flow_id": "0694164d-b46c-477c-b7c6-0b7902c7fbad",
                "suggest_links": [
                    {
                        "title": "Layanan Sosial",
                        "link": "https://majadigi.jatimprov.go.id/sosial"
                    },
                    {
                        "title": "Layanan Lingkungan Hidup",
                        "link": "https://majadigi.jatimprov.go.id/lingkungan-hidup"
                    },
                    {
                        "title": "Layanan Kabupaten & Kota",
                        "link": "https://majadigi.jatimprov.go.id/kabupaten-&-kota"
                    },
                    {
                        "title": "Layanan Ekonomi dan Bisnis",
                        "link": "https://majadigi.jatimprov.go.id/ekonomi-dan-bisnis"
                    }
                ]
            }
        ],
        "sessionId": "0694164d-b46c-477c-b7c6-0b7902c7fbad"
    },
    "statusCode": 200,
    "message": "OK"
}

Kode Status Respons

Deskripsi: Tabel ini menjelaskan kode status yang mungkin diterima sebagai respons dari permintaan yang dikirim ke chatbot.

Kode

Deskripsi

200

OK