Autentikasi

Setiap permintaan diautentikasi dengan API key workspace yang dikirim sebagai Authorization: Bearer YOUR_API_KEY. Respons memakai format { status, message, data }.

Buka Pengaturan → API key di workspace Anda dan buat key.
Pilih scope yang dibutuhkan key. Jangan sertakan yang tidak perlu.
Salin key. Key hanya ditampilkan sekali; yang disimpan hanya hash-nya.

Request

curl -X GET "https://www.beamvia.com/api/v1/channel" \
  -H "Authorization: Bearer YOUR_API_KEY"

Scope

Scope	Memberi akses
message:send	Mengirim pesan di kanal mana pun
conversation:read	Melihat percakapan dan pesannya
conversation:write	Mengubah status dan penangan percakapan
contact:read	Melihat kontak
contact:write	Membuat dan mengubah kontak
channel:read	Melihat kanal dan statusnya
webhook:manage	Membuat dan menghapus webhook
event:write	Kirim event ke AI agent
plugin:read	Panggil aksi plugin yang membaca (mis. daftar pesanan)
plugin:write	Panggil aksi plugin yang mengubah data (mis. buat pesanan)

Batas

Permintaan dihitung terhadap kuota API harian paket Anda per jenis kanal, dan pesan terkirim terhadap kuota pesan harian. Jika melebihi batas, permintaan mengembalikan 429 sampai hari berikutnya (UTC).

Error

Error memakai format yang sama dengan status false dan pesan yang mudah dibaca.

Kode	Arti
400	Body atau parameter permintaan tidak valid
401	API key tidak ada, tidak valid, atau sudah dicabut
402	Paket Anda tidak mencakup fitur ini
403	Key tidak memiliki scope yang dibutuhkan, atau kanal terkunci
404	Data tidak ditemukan di workspace ini
409	Konflik, misalnya identitas sudah dimiliki kontak lain
429	Kuota harian tercapai

Response

{
  "status": false,
  "message": "Daily API request quota exceeded",
  "data": null
}