Broadcast campaign management
List campaigns
Mengembalikan daftar campaign dengan informasi template, dipaginasi.
query Parameters
pageper_pagestatusFilter berdasarkan status: draft, scheduled, sending, completed, failed, cancelled
List campaigns › Responses
Daftar campaign dengan metadata paginasi
totalpageper_pagetotal_pagesCreate a new campaign (draft)
Membuat campaign baru berstatus draft. Template harus berstatus APPROVED.
Create a new campaign (draft) › Request Body
nametemplate_idTemplate harus berstatus APPROVED
scheduled_atintegration_account_idCreate a new campaign (draft) › Responses
Campaign berhasil dibuat
idnametemplate_idstatustotal_recipientssent_countdelivered_countread_countfailed_countcreated_bycreated_atupdated_atscheduled_atintegration_account_idGet a campaign
Mengembalikan detail campaign beserta informasi template.
path Parameters
idGet a campaign › Responses
Detail campaign
idnametemplate_idstatustotal_recipientssent_countdelivered_countread_countfailed_countcreated_bycreated_atupdated_atscheduled_atintegration_account_idtemplate_nametemplate_languageUpdate a draft campaign
Hanya campaign berstatus draft yang dapat diubah. Template baru harus berstatus APPROVED.
path Parameters
idUpdate a draft campaign › Request Body
nametemplate_idscheduled_atintegration_account_idUpdate a draft campaign › Responses
Campaign berhasil diperbarui
idnametemplate_idstatustotal_recipientssent_countdelivered_countread_countfailed_countcreated_bycreated_atupdated_atscheduled_atintegration_account_idtemplate_nametemplate_languageList campaign recipients
Mengembalikan daftar penerima campaign beserta nama kontak, dipaginasi.
path Parameters
idquery Parameters
pageper_pagestatusFilter berdasarkan status penerima
List campaign recipients › Responses
Daftar penerima dengan metadata paginasi
totalpageper_pagetotal_pagesAdd recipients to a campaign
Tambahkan penerima berdasarkan contact_ids, tags, dan/atau phone_numbers. Duplikat per nomor telepon diabaikan. Hanya campaign draft yang menerima penerima baru.
path Parameters
idAdd recipients to a campaign › Request Body
contact_idsTambahkan penerima berdasarkan ID kontak
tagsTambahkan semua kontak dengan tag yang cocok
phone_numbersTambahkan penerima langsung berdasarkan nomor telepon
variablesPemetaan variabel per nomor telepon: {"628xxx": {"1": "John", "2": "#123"}}
Add recipients to a campaign › Responses
Penerima berhasil ditambahkan
messageaddedskippedSend or schedule a campaign
Mengirim campaign secara langsung atau menjadwalkannya.
- Jika scheduled_at ada dan di masa depan: status berubah ke scheduled.
- Jika tidak: campaign dikirim langsung, status berubah ke completed atau failed.
Memerlukan flag can_broadcast = true pada profil agent.
path Parameters
idSend or schedule a campaign › Responses
Campaign dikirim atau dijadwalkan
messagetotal_recipientssentfailedscheduled_atHanya ada jika campaign dijadwalkan