3Dolphins
5.2 EN
5.2 EN
  • Get Started
  • Pre-Requisite
  • FAQ User
    • User Management
      • What should I do if the user still has an active session?
      • What should I do if the user is locked?
    • Ticket Management
      • What should I do if the customer ticket cannot enter the assigned tab?
    • Bot Settings
      • What should I do if the bot doesn’t respond?
      • What should I do if the bot doesn’t respond as expected?
    • Data Settings
      • Which App Server, Web Server, and Database are used by Chatbot 3Dolphins SRM?
      • When Chatbot is running on Linux. What process does UP / RUNNING signify that the app is running?
      • If the process experiences an abnormal stop (fall) and cannot be increased again in the normal way.
      • How to monitor 3rd party service?
      • On performance monitoring. Can it be monitored and does it have a dashboard?
      • What needs to be backup?
      • How do backup Solr? Is there a menu from apps to do backups?
      • What Backup cycle is used? Full or incremental?
      • What data is stored on the server?
      • Housekeeping data procedures and technical guidelines. Is there a menu from Apps?
      • How to convert milliseconds API fields to Apache Solr Date format using Microsoft Excel
  • Task Management
    • Task Management
      • Task Feature
      • Create Task
      • Edit Task
      • Detail Task Feature
  • Administration
    • User Privilege
      • User Role and Permission Level
      • Grant and Revoke Module Access
      • Create New Privilege
      • Remove Privilege
    • User Management
      • Group
      • Line of Business
      • User
      • Blocked
      • Active
      • Upload
      • Dual Control
      • Team Collaboration Chat
    • System Setting
      • Ticket Configuration
        • Number of Ticket History
        • Reply Signature
        • Enable Watermark on Attachment
        • Operator Allow Ticket Redistribute
        • Pop-Up Chat On Idle
        • Severity Required Before Closed
        • Auto Send Feedback
        • Claim Ticket Count
        • Enable Reopen Ticket
        • Enable Block Contact
        • Group Ticket Distribution
        • Traffic Minimal Turn
        • Last Agent Saved in Memory
        • Default Transfer Type
        • Default Sorting Mode
        • Enable Batch Close Ticket
        • Webchat Queue All Channel
        • Word Sensor on Live Agent Message
        • Ticket Claim Mode
        • Auto Greeting
        • Ask Feedback Message
        • Image URL Link and Font Color for Feedback Link
        • Feedback Appreciate Message
        • Number of Live Chat History
        • Walk in SLA Time (in Second)
        • Closure Types
      • User Configuration
      • Bot Configuration
      • Contact Configuration
      • Lead Configuration
      • Deal Configuration
      • Company Configuration
      • Custom Submenu Configuration
    • Data Settings
      • Create New Collection
        • Add Fields in Collection
        • Purge Data Collection
      • Remove Collection
      • Archive Collection
    • Public Holiday
      • Create New Holiday
      • Edit an Existing Public Holiday
      • Delete an Existing Public Holiday
    • Co-Browsing
      • Add Co-Browsing Menu
      • How to Use Co-Browsing
  • Integration
    • Channel Connector
      • Telegram Bot
        • Create Telegram Bot
        • Create New Telegram Bot Channel
        • Create New Rule
        • Attach Bot
        • Start Chat
      • Email Inbox
        • Create New Channel Email Inbox
        • How to Setup Outlook Email
        • Gmail Settings
        • Yahoo Settings
        • Create New Rule
        • Reply Email
        • Forward Email
      • Live Chat
        • Create New Live Chat Channel
        • How to Connect Client to Live Chat Channel
        • Create New Rule
        • Live Chat Message
        • Live Chat Capabilities
        • Include Livechat to your Website / Mobile (Webview)
          • Website
          • Mobile (Android Webview)
          • Mobile (IOS Webview)
        • Live Chat SDK React Native
        • Live Chat SDK Kotlin
        • Live Chat SDK Swift
      • Telegram Account
        • Create a New Telegram Account
        • Create a New Channel of Telegram Account
        • Create New Rule
        • Attach Bot
      • Twitter
        • Create Twitter Account
        • Twitter Developers
        • Create New Twitter Channel
        • Create New Rule
        • Result of Create New Twitter Channel
        • Best Practice Twitter
          • Customer
          • Agent (Operator) or Supervisor
      • Facebook
        • Facebook Developers
        • Verify Your Business
        • How to Create Facebook App
          • Change Additional Information About the App
          • How to Add Facebook Login Platform to Your Facebook App
          • Permission And Feature
        • Create New Page on Facebook
        • Create New Facebook Channel
        • How to Add Messenger Platform to Your Facebook App
        • How to Add Webhooks Platform to Your Facebook App
        • Create New Rule
        • Mechanism for using BOT in Facebook Messenger
        • How to Add an Email from My Facebook Account
        • Best Practice Facebook
          • BOT
          • Customer
          • Agent (Operator) and Supervisor
        • Facebook Gateway
      • WhatsApp Business API
        • How to Set Up Whatsapp Business API
        • Create New Whatsapp Channel
        • Create New Rule
        • Result Create New Whatsapp Business Channel
      • Instagram Bussiness
        • Facebook Developers
        • Verify Your Business
        • How to Create Facebook App
          • Change Additional Information About the App
          • How to Add Facebook Login Platform to Your Facebook App
          • Permission And Feature
        • Create New Page on Facebook
        • Create New Instagram Business Account
        • Create New Instagram Business Channel
        • How to Add Webhooks Platform to Your Facebook App
        • How to Add Instagram Platform to Your Facebook App
        • Create New Rule
        • Result of Create New Instagram Business Channel
        • Best Practice Instagram
        • Instagram Gateway
      • Line Account
        • Create New Line Official Account
        • Create Line Developer
        • Create New Line Account Channel
        • Create New Rule
        • Attach Bot
        • Result of Create New Line Account Channel
      • Skype
        • Create Bot With Microsoft Bot Framework and Microsoft Azure
        • Create New Skype Channel
        • Create New Skype Account
        • Create New Rule
        • Result of Create New Skype Channel
      • App Follow
        • Create a New Channel of App Follow
        • Create New Rule
        • How to Create Ticket on App Follow
      • YouTube
        • Create New Channel on YouTube
        • How to Create YouTube API Credentials
        • Create New Channel of YouTube
        • Create New Rule
        • Result Create New Youtube Channel
      • Smartcall
        • Create New Channel Smartcall
        • Add Telephony Credentials
        • Create New Rule
        • Result of Create New Smartcall Channel
      • Webex
        • Create Webex Account
        • Create New Webex Bot
        • Create New Webex Channel
        • Create New Rule
        • Attach Bot
        • Result of Create New Webex Channel
    • Live Chat Designer
      • New Design
        • Style
        • Live Chat Connection
        • On Boarding Form
        • Livechat Label
        • Messaging Setting
        • Display Settings
        • Widget Settings
        • Member Mode
        • Queue
        • Error Message
        • Voice and Speech
        • Campaign
        • Service Hour
        • On Boarding Email Form
        • Input Validation
        • Generate Script
      • View Script Widget
      • Edit Widget
      • Remove Widget
    • Third-Party Integration
  • Employee
    • Operator Shift
      • Add New Shift
      • Edit Shift
      • Assign Operator Shift
      • Operator Shift Change Availability
      • Delete Shift
    • Shift Mapping
      • Upload Agent’s Attendance
      • Edit an Existing Shift
      • Delete Shift
      • Filter Shift
    • Operator Target
      • Add Multiple Target
      • Add Operators Target (Independent Target)
    • Group KPI
      • Create New Group KPI
      • Add New Group KPI
        • Edit Group KPI
        • Filter Group KPI
        • Delete Group KPI
      • Filter and Search Group KPI Module
    • Announcement
      • Create New Announcement
      • Edit Announcement
      • Remove Announcements
  • Marketing
    • Public Post
      • Create New Public Post
        • Upload File
        • Schedule, Post, and Draft
      • Filter and Search Public Post
    • Notification
      • Create Notification
        • Account & Recipients
        • Message
        • Send or Schedule
      • Filter and Search Notification
      • Edit and Delete Notification
      • Quality Rating Notification
    • Template
      • Request Template
        • Authentication Template
          • Code delivery
          • Message Content
        • Marketing & Utility Template
          • Header Template
          • Body Template
          • Footer Template
          • Buttons Template
      • Filter and Search Template
      • Delete Template
    • Audience
      • Create New Audience
      • Edit and Delete Existing Audience
      • Import Audience
      • Create New Audience Group
      • Edit and Delete Existing Audience Group
      • Search Feature
      • WhatsApp Validation
    • Maker Checker
      • Public Post Maker
      • Public Post Checker
      • Notification Maker
      • Notification Checker
  • Sales Activity
    • Lead
      • Create New Lead
      • Import Lead
      • Detail Lead
        • Contact Info
        • Company Info
        • Transfer Lead Ownership
        • Note
        • Task
      • Filter and Search Lead
      • Lead Automation
        • Automation Component
        • Create Automation
        • Duplicate and Delete Automation
      • Convert Lead to Deal or Archive Lead
      • Unarchive Lead
      • Delete Lead
    • Deal
      • Create New Deal
      • Detail Deal
        • Add Product on Deal
        • Contact Info
        • Company Info
        • Transfer Deal Ownership
        • Note
        • Task
        • Add On-Site Visit
        • Add Expenses
      • Transfer Deal to Another Pipeline
      • Pipeline
        • Add New Pipeline
        • Edit Pipeline
        • Delete Pipeline
      • Filter, Sort, and Search Deal
      • Advanced Setting
      • Closed Deal to Won or Lost Deal
      • Delete Deal
    • Contact
      • Create New Contact
      • Detail Contact
        • Switch and Unlink Companies
        • Add Deal
        • Set Contact as VIP
        • Block and Unblock Contact
        • Merge Contact
        • Note
        • Task
      • Delete Contact
    • Company
      • Create New Company
      • Detail Company
      • Search Company and Configuration Table
      • Delete Company
    • Product
      • Create New Product
      • Detail Product
        • Open Deals
        • Stock and Restock Product
        • Transfer Product Ownership
        • Note
        • Filter and Search Product
      • Configuration Table
      • Delete Product
  • Customer Service
    • Introduction
    • Customer Support
      • Monitoring Dashboard Agent
      • Monitoring Dashboard Supervisor
      • Search in Dashboard
      • Change Status Agent
      • Reply Ticket
      • Send File or Attachment
        • Send File
        • Send Library
        • Send Form
        • Chat History
        • Send FAQ
        • Video Conference Call
      • Watermark
      • Ticket Activity
        • Add Customer Case
        • Add Task based on Ticket
        • Customer Identify
      • Ticket Priority
      • Ticket Notification
      • Filter Ticket
      • Team Member
      • Escalated Ticket
      • Transferred Ticket
      • Reassign Ticket
      • Takeover Ticket
      • Closed Ticket
      • Share Ticket Link
      • View Chat History
      • Merge and Unmerge Ticket
      • Merge Contact
      • Merge Contact Suggestion
      • Blocked Ticket
      • Reopen Ticket
      • Canned Message
      • How to Find FAQ
      • How to Export Ticket
      • How to Create Outbound Email
      • How to Create Offline Ticket
      • View Assignment Rule
      • How to Make Outbound Whatsapp Message
    • Customer Contact
      • Create New Contact
      • Download Contact
      • Edit Contact
      • Case Timeline
      • Ticket History
      • Merge Contact
      • Merge Contact Suggestion
      • Send Email Message
      • Blocked Contact
      • Remove Contact
    • Ticket Automation
      • Automation Component
      • Tag, Severity, Priority and Process Flow
      • On Idle Trigger Ticket
      • Auto Greeting with Time Based Response
      • Bypass Ticket Distribution for High Profile Customer
    • Agent Automation
      • Create New Agent Automation
      • Automation Component
      • On Aux Changes Trigger Agent
      • On Agent Idle Trigger
    • Unit Management
      • Create New Unit
      • Unit Transfer Ticket
      • Edit Existing Unit
      • Delete Existing Unit
    • Rule Management
      • Add New Rule
        • Add Team Members
        • Add Rule Criteria
      • Configuration Rule
        • SLA Settings
        • Assignment
        • Service Hour
      • Clone Rule
      • Remove Rule
      • Filter Rule
      • Reload Rule
      • Traffic Distribution
        • Set Ratio Rule
        • Traffic Wallboard
      • Max Assignment
    • Form Management
      • Form Records
        • Filter Form Records
        • Download Form Records
      • Form Builder
        • Create New Form Builder
          • Settings
          • Generate Link
        • Edit Form Builder
        • Remove Form Builder
    • Paragraph Classifier
      • Add New Classifier Module
      • Add Classifier
      • Classifier Setting
      • Add Tags to Chat Tickets
      • Add Tags to Customer Contact
      • Edit Classifier
      • Remove Classifier
    • Email Template
      • New Email Template
      • Edit Email Template
      • Remove Email Template
      • Email Signature
      • Auto-Reply
    • Auxiliary Mapping
      • Create New Agent Status
      • Edit an Existing Agent Status
      • Remove Agent Status
    • Teaser Management
      • Create New Teaser
      • Active and Inactive Teaser
      • Preview Teaser
      • Edit Teaser
      • Delete Teaser
      • Search Teaser
  • Quality Assurance
    • Performance Rating
      • Add Appraisal Report
      • Upload Appraisal Report
      • Transfer Appraisal Report
      • Change Appraisal Report
      • Filter Ticket
    • Customer Feedback
    • Feedback Template
      • Create New Feedback Question
        • Agent Rating Survey
        • NPS Survey
      • Attach Feedback Template
      • Activate and Deactivate Feedback Template
      • Edit Feedback Template
      • Delete Feedback Template
    • Rating Criteria
      • Add New Template Criteria
      • Add Criteria
      • Active and Inactive Template
      • Duplicate Template Criteria
      • Delete Template Criteria
  • Bot Settings
    • Bot Manager
      • Create New Bot
        • Attach Dialog
        • Attach FAQ
        • Channel Deployment
        • Timeout Message
        • Unrecognized Setting
        • Fallback Message
        • 3Dolphins Think Integration
        • Bot Option Configuration
        • Bot Assistant
        • Bot Contextual
        • Bot Language
      • Bot Profile Settings
      • General Synonym
      • Evaluate BOT
        • Create Validation Script
        • Validate the Script
        • Upload Script Validation
      • Automatic Detection Language
    • Process Flows
      • Component of Workflow
        • Webhook
        • Execute Command
        • HTTP Request
        • MVEL Function
        • Execute Workflow
        • Timer Interval
        • Send Message
        • Send Email
        • Show Growl
        • Connector Setting
      • Integration
      • List of Workflow
      • Edit Workflow
        • Merge Request Workflow
      • Remove Workflow
      • Workflow Log
    • Dialog Flows
      • Create New Dialog
        • Intention and Entity
        • Prompt Response
          • New Line & InLine
          • Quick Reply
          • Media
          • Catalog
          • WhatsApp Flows
        • Integration
        • Configuration
        • Build Dialog Model
        • Test the Dialog on Bot Emulator
      • Export Dialog Flows
      • Search and Filter Dialog
      • Switch Dialog
      • Bot Macro Commands
    • FAQ Knowledge
      • Create New FAQ Knowledge
      • Upload FAQ Knowledge
      • Export FAQ Knowledge
      • FAQ Knowledge Contextual
      • Edit Knowledge
      • Clone Knowledge
      • Remove Knowledge
      • Search Knowledge
      • Filter Knowledge
      • Macro Knowledge
    • FAQ Suggestion
      • Mechanism of Using FAQ Suggestion
    • Digital Library
      • Create New Digital Library
        • Send Card
        • Send Option
        • Send Image
        • Send Document
        • Send Video
        • Send Audio
      • Edit Digital Library
      • Remove Digital Library
    • Page Builder
      • Add New Page
        • New Page Feature
      • Edit Page Builder
      • Generate Link Page
      • Download Raw Data of Pages as JSON Format
      • Remove Page Builder
    • Payment Library
      • Add New Payment
      • Edit Payment Library
      • Delete Payment Library
    • Think Paragraph
      • Add Document (Article)
      • Edit Document (Article)
      • Ask Question Article
      • Delete Document (Article)
      • Think Paragraph Configuration
    • Maker Checker
      • Process Flow Maker
      • Process Flow Checker
  • Analytic
    • Live Agent
      • Conversation History
        • Filter Conversation History
        • Download Conversation History
      • Appraisal Report
        • Filter Appraisal Report
        • Download Appraisal Report
      • Channel Interaction
        • Filter Channel Interaction
        • Download Channel Interaction
      • Channel Group SLA
        • Filter Channel Group SLA
        • Download Channel Group SLA
      • Live Agent SLA
        • Filter Live Agent SLA
        • Download Live Agent SLA
      • Live Agent Performance
        • Filter Live Agent Performance
        • Download Live Agent Performance
      • Live Agent Productivity
        • Filter Live Agent Productivity
        • Download Live Agent Productivity
      • Live Agent Rating
        • Filter Live Agent Rating
        • Download Live Agent Rating
      • Customer Rating
        • Filter Customer Rating
        • Download Customer Rating
      • Visitors Volume
        • Filter Visitors Volume
        • Download Visitors Volume
      • Bot Visitor Volume
        • Filter Bot Visitor Volume
        • Download Bot Visitor Volume
      • Conversation Audit
        • Filter Conversation Audit
        • Download Conversation Audit
      • User Access Audit
        • Filter User Access Audit
        • Download User Access Audit
      • User AUX Audit
        • Filter User AUX Audit
        • Download User AUX Audit
      • Net Promotor Score
        • Filter Net Promotor Score
        • Download Net Promotor Score
      • Analytic Setting
      • Create New Service Analytic
    • Virtual Agent
      • Bot Overview
        • Intent Data
        • Intent Score
        • Download All Intents
        • Filter Bot Overview
      • Bot Engagement
        • Download Bot Engagement
        • Filter Bot Engagement
      • Business Service
        • Filter Business Service
      • Intents Fallback
        • Download Intents Fallback
        • Filter Intents Fallback
      • User Transaction
        • Filter User Transaction
      • Bot Satisfaction
        • Download Bot Satisfaction
    • Employee
      • Operator Target
        • Filter Operator Target
        • Download Operator Target
      • Group KPI Report
        • Filter Group KPI Report
        • Download Group KPI Report
      • Attendance Report
        • Filter Attendance Report
        • Download Attendance Report
      • Task Report
        • Filter Task Report
        • Download Task Report
    • Sales
      • Deal Progress
        • Filter Deal Progress
        • Download Deal Progress
      • Deal Conversion
        • Filter Deal Conversion
        • Download Deal Conversion
      • Deal Overdue
        • Filter Deal Overdue
        • Download Deal Overdue
      • Deal Won
        • Filter Deal Won
        • Download Deal Won
      • Deal Lost
        • Filter Deal Lost
        • Download Deal Lost
    • WhatsApp
      • Filter Whatsapp Usage
      • Download Whatsapp Usage
    • Wallboard
      • Wallboard Channel
      • Wallboard Agent
      • Wallboard Classifier
      • Wallboard Configuration
  • API
    • Service API
      • Ping API
      • Get Token
      • Auxiliary Mapping
      • Channel Connector API
      • Support Chart API
      • Contact API
      • File Upload Service
      • Form API
      • Location API
      • Marketing API
        • WhatsApp Broadcast
        • Line Broadcast
      • Profile API
      • Push Notification API
      • Report API
      • Ticket File Media API
      • Operator API
      • Ticket API
      • Supervisor API
      • Users API
      • Email Outbound API
      • Task API
    • Bot API
      • Get Token
      • Get Bot Response
      • Get Bot by Bot Id and Get list of Bots
      • Get Bot Deployment Channel by Bot Id
      • Get Bot FAQ Modules by Bot Id
      • Get Bot Dialogs by Bot Id
      • Post Bot Responses by Bot Id and User Message
      • NLP API
      • Think Paragraph API
    • Sales API
      • Get Token
      • Company API
      • Product API
      • Pipeline API
      • Deal API
      • Notes API
      • Lead API
  • SLA Guidelines
Powered by GitBook
On this page
  • Create Recipients
  • Verify Phone Number
  • Send Broadcast Text
  • Send Broadcast Image
  • Send Broadcast Image
  • Send Broadcast Video
  • Send Broadcast Video
  • Send Broadcast Document
  • Send Broadcast Document
  • Send Broadcast Quick Reply
  • Send Broadcast Quick Reply
  • Send Broadcast Macro in Body
  • Send Broadcast Macro in Body
  • Send Broadcast Macro in Header and Body
  • Send Broadcast Macro in Header and Body
  • Send Multiple Broadcast
  • Send Multiple Broadcast
  • Get Broadcast Detail by ID
  • Create Broadcast WhatsApp

Was this helpful?

  1. API
  2. Service API
  3. Marketing API

WhatsApp Broadcast

Component Explanation :

Field Name

Description

Required

Authorization

Generated token id

Yes

name

Name of your broadcast

Yes

channel

Channel id of your used channel

Yes

sendingMode

The sending method you will use. Currently there are 2 sending mode, i.e : send immediately (now) and scheduled send (scheduled)

possible value: Now, Scheduled

Yes

scheduledDate

The date and time scheduled for sending broadcast

Field format: "yyyy-mm-dd hh:mm:sss"

Yes, when sending mode is 'Scheduled'

templateId

Id of the template that you want to use for your broadcast

wa-template-id must defined first in 3Dolphins UI

Yes

recipient

your recipient id

acquired from creating recipient with Recipient endpoint

Yes

headerVariables

Variable object of your header

Yes, only when WhatsApp template being used has macro in Header

bodyVariables

Variable object of your body

Yes, only when WhatsApp template being used has macro in Body

content

the contents of your broadcast message.

Note : For WhatsApp broadcast you can only attach one media on a single broadcast

Yes

botId

your bot id when the dialog trigger is used.

No

dialogId

your dialog id that will be used as trigger dialog.

No

whatsappRecipient

your phone number's recipients.

Yes

You don't need to use whatsappRecipient field if you already use recipient field. This also applies in a reverse way.

Create Recipients

Method
POST

Media Type

application/json

URL

Header

Authorization : Bearer [generatedToken]

Body Create Recipients

To create recipients, you must upload your recipient number with format xlsx. You must fill the recipients data and save it with format xlsx, like image below.

You can choose form-data format on Body and fill the key with 'uploadFile', change the type with file then you can click select files button to select recipient document on your device. Click Send button to upload file.

You can choose form-data format on Body and fill the key with 'uploadFile', change the type with file then you can click select files button to select recipient document on your device. Click Send button to upload file.

Response

Response status: 200

Response status: 200

{
  "recipient_id": "[recipient id]" *generated automatically by system
}

Verify Phone Number

Method

POST

Media Type

application/json

URL

Header

Authorization : Bearer [generatedToken]

Body

["{phone-number-1}", "{phone-number-2}" , .... ]

Note: Phone number must filled with format '62' (country code) or '0',

Can't filled with '+'

Response:

Response status: 200

Response status: 200

{
  "status": "success",
  "data": [
    {
      "input": "phone-number-1",
      "status": "valid"
    },
    {
      "input": "phone-number-2",
      "status": "invalid"
    }
  ],
  "hasMore": false,
  "nextIndex": 0,
  "prevIndex": 0,
  "totalResults": 0
}

Send Broadcast Text

Method

POST

Media Type

application/json

URL

https://[server]/dolphin/apiv1/graph/broadcast

Header

Authorization: Bearer [generatedToken]

Body:

Body:

{
    "name":"your-broadcast-name",
    "channel":"channel-used-for-broadcast",
    "sendingMode":"sending-mode",
    "scheduledDate":"2021-01-01 23:30:334",
    "templateId" : "wa-template-id", 
    "recipient": "recipient-id",  
    "content" : [
        
    ]
}

Response: 200

Response:

Response status: 200

{
  "status": "success",
  "data": {
    "id": "[broadcast-id]"
  },
  "message": "Successfully make Broadcast Item",
  "hasMore": false,
  "nextIndex": 0,
  "prevIndex": 0,
  "totalResults": 0
}

Example Send Broadcast Text

Below is a representation when using the WhatsApp broadcast API for sending a broadcast text on the 3Dolphins application.

When you enter the channel field using the channel id in the API, it will be like selecting an account on the application and the templateId field like selecting the notification template. The name field will also be the title for your notification. SendingMode field is like specifying the sending option to be used (if you use 'schedule', you can choose when the notification will be sent).

Send Broadcast Image

Example Send Broadcast Text

Body:

Below is a representation when using the WhatsApp broadcast API for sending a broadcast text on the 3Dolphins application.

When you enter the channel field using the channel id in the API, it will be like selecting an account on the application and the templateId field like selecting the notification template. The name field will also be the title for your notification. SendingMode field is like specifying the sending option to be used (if you use 'schedule', you can choose when the notification will be sent).

Send Broadcast Image

Method

POST

Media Type

application/json

URL

https://[server]/dolphin/apiv1/graph/broadcast

Header

Authorization: Bearer [generatedToken]

Body:

{
    "name":"your-broadcast-name",
    "channel":"channel-used-for-broadcast",
    "sendingMode":"sending-mode",
    "scheduledDate":"2021-01-01 23:30:334",
    "templateId" : "wa-template-id", 
    "recipient": "recipient-id",  
    "content" : [
       {     
            "type": "image",
            "url": "your-url-for-image", | url https, format jpg/png
        }
    ]
}

Response: 200

Response:

Response status: 200

{
  "status": "success",
  "data": {
    "id": "[broadcast-id]"
  },
  "message": "Successfully make Broadcast Item",
  "hasMore": false,
  "nextIndex": 0,
  "prevIndex": 0,
  "totalResults": 0
}

Example Send Broadcast Image

Below is a representation when using the WhatsApp broadcast API for sending a broadcast image on the 3Dolphins application.

When you enter the channel field using the channel id in the API, it will be like selecting an account on the application and the templateId field like selecting the notification template (when using images notification template, you must fill in the 'type' field with 'image' and your image url with https format and image extension type). The name field will also be the title for your notification. SendingMode field is like specifying the sending option to be used (if you use 'schedule', you can choose when the notification will be sent).

Send Broadcast Video

Example Send Broadcast Image

Body:

Below is a representation when using the WhatsApp broadcast API for sending a broadcast image on the 3Dolphins application.

When you enter the channel field using the channel id in the API, it will be like selecting an account on the application and the templateId field like selecting the notification template (when using images notification template, you must fill in the 'type' field with 'image' and your image url with https format and image extension type). The name field will also be the title for your notification. SendingMode field is like specifying the sending option to be used (if you use 'schedule', you can choose when the notification will be sent).

Send Broadcast Video

Method

POST

Media Type

application/json

URL

https://[server]/dolphin/apiv1/graph/broadcast

Header

Authorization: Bearer [generatedToken]

Body:

{
    "name":"your-broadcast-name",
    "channel":"channel-used-for-broadcast",
    "sendingMode":"sending-mode",
    "scheduledDate":"2021-01-01 23:30:334",
    "templateId" : "wa-template-id", 
    "recipient": "recipient-id",  
    "content" : [
        {
            "type": "video",
            "url": "your-url-for-video", | url https, format mp4
            "thumbnailUrl" : "your-url-for-thumbnail"
        }
    ]
}

Response: 200

Response:

Response status: 200

{
  "status": "success",
  "data": {
    "id": "[broadcast-id]"
  },
  "message": "Successfully make Broadcast Item",
  "hasMore": false,
  "nextIndex": 0,
  "prevIndex": 0,
  "totalResults": 0
}

Example Send Broadcast Video

Below is a representation when using the WhatsApp broadcast API for sending a broadcast video on the 3Dolphins application.

When you enter the channel field using the channel id in the API, it will be like selecting an account on the application, as well as the templateId field like selecting the notification template (when using video notification template, you must fill in the 'type' field with 'video' and your video url with https format and video extension type). The name field will also be the title for your notification. SendingMode field is like specifying the sending option to be used (if you use 'schedule', you can choose when the notification will be sent).

Send Broadcast Document

Example Send Broadcast Video

Body:

Below is a representation when using the WhatsApp broadcast API for sending a broadcast video on the 3Dolphins application.

When you enter the channel field using the channel id in the API, it will be like selecting an account on the application and the templateId field like selecting the notification template (when using video notification template, you must fill in the 'type' field with 'video' and your video url with https format and video extension type). The name field will also be the title for your notification. SendingMode field is like specifying the sending option to be used (if you use 'schedule', you can choose when the notification will be sent).

Send Broadcast Document

Method
POST

Media Type

application/json

URL

https://[server]/dolphin/apiv1/graph/broadcast

Header

Authorization : Bearer [generatedToken]

Body:

{
    "name":"your-broadcast-name",
    "channel":"channel-used-for-broadcast",
    "sendingMode":"sending-mode",
    "scheduledDate":"2021-01-01 23:30:334",
    "templateId" : "wa-template-id", 
    "recipient": "recipient-id",  
    "content" : [
        {
            "type": "document",
            "url": "your-url-for-document", | url https, format pdf
        }
    ]
}

Response:

Response status: 200

Response status: 200

{
  "status": "success",
  "data": {
    "id": "[broadcast-id]"
  },
  "message": "Successfully make Broadcast Item",
  "hasMore": false,
  "nextIndex": 0,
  "prevIndex": 0,
  "totalResults": 0
}

Example Send Broadcast Document

Below is a representation when using the WhatsApp broadcast API for sending a broadcast document on the 3Dolphins application.

When you enter the channel field using the channel id in the API, it will be like selecting an account on the application and the templateId field like selecting the notification template (when using document notification template, you must fill in the 'type' field with 'document' and your document url with https format and document extension type). The name field will also be the title for your notification. SendingMode field is like specifying the sending option to be used (if you use 'schedule', you can choose when the notification will be sent).

Send Broadcast Quick Reply

Example Send Broadcast Document

Body:

Below is a representation when using the WhatsApp broadcast API for sending a broadcast document on the 3Dolphins application.

When you enter the channel field using the channel id in the API, it will be like selecting an account on the application snd the templateId field like selecting the notification template (when using document notification template, you must fill in the 'type' field with 'document' and your document url with https format and document extension type). The name field will also be the title for your notification. SendingMode field is like specifying the sending option to be used (if you use 'schedule', you can choose when the notification will be sent).

Send Broadcast Quick Reply

Method
POST

Media Type

application/json

URL

https://[server]/dolphin/apiv1/graph/broadcast

Header

Authorization : Bearer [generatedToken]

Body:

{
    "name":"your-broadcast-name",
    "channel":"channel-used-for-broadcast",
    "sendingMode":"sending-mode",
    "scheduledDate":"2021-01-01 23:30:334",
    "templateId" : "wa-template-id", 
    "recipient": "recipient-id",  
    "content" : [ 
    
    ]
}

Response:

Response status: 200

Response status: 200

{
  "status": "success",
  "data": {
    "id": "[broadcast-id]"
  },
  "message": "Successfully make Broadcast Item",
  "hasMore": false,
  "nextIndex": 0,
  "prevIndex": 0,
  "totalResults": 0
}

Example Send Broadcast Quick Reply

Below is a representation when using the WhatsApp broadcast API for sending a broadcast quick reply on the 3Dolphins application.

When you enter the channel field using the channel id in the API, it will be like selecting an account on the application and the templateId field like selecting the notification template. The name field will also be the title for your notification. SendingMode field is like specifying the sending option to be used (if you use 'schedule', you can choose when the notification will be sent).

Send Broadcast Macro in Body

Example Send Broadcast Quick Reply

Body:

Below is a representation when using the WhatsApp broadcast API for sending a broadcast quick reply on the 3Dolphins application.

When you enter the channel field using the channel id in the API, it will be like selecting an account on the application and the templateId field like selecting the notification template. The name field will also be the title for your notification. SendingMode field is like specifying the sending option to be used (if you use 'schedule', you can choose when the notification will be sent).

Send Broadcast Macro in Body

Method
POST

Media Type

application/json

URL

https://[server]/dolphin/apiv1/graph/broadcast

Header

Authorization : Bearer [generatedToken]

Body:

{
    "name":"your-broadcast-name",
    "channel":"channel-used-for-broadcast",
    "sendingMode":"sending-mode",
    "scheduledDate":"2021-01-01 23:30:334",
    "templateId" : "wa-template-id", 
    "recipient": "recipient-id",  
    "bodyVariables" : [ 
        {
            "type": "personalized", 
            "key": "{{1}}", 
            "value": "Nama"
        },  
        {
            "type": "personalized", 
            "key": "{{2}}", 
            "value": "Title"
        }
    ],
    "content" : [ 
    
    ]
}

Response:

Response status: 200

Response status: 200

{
  "status": "success",
  "data": {
    "id": "[broadcast-id]"
  },
  "message": "Successfully make Broadcast Item",
  "hasMore": false,
  "nextIndex": 0,
  "prevIndex": 0,
  "totalResults": 0
}
Field
Description

Variables Object

Variables Object is required object for template that has macro. The object has key and value component

Key

This key refer to macro that available in broadcast template, example : {0}, {1}, {2}

Value

Value refer to field we define in recipient file, as shown below

Example of macro variable:

Example of recipient file (must be .xlsx format) :

In example above, field that being defined is Nama and Title. We can use this field on our Header Variables/Body Variables.

Example Send Broadcast Macro in Body

Below is a representation when using the WhatsApp broadcast API for sending a broadcast macro in the notification body.

When you enter the channel field using the channel id in the API, it will be like selecting an account on the application and the templateId field like selecting the notification template. The name field will also be the title for your notification. The template variables field for the body will appear when you use a broadcast macro to fill in the values for the key, type, and value fields. SendingMode field is like specifying the sending option to be used (if you use 'schedule', you can choose when the notification will be sent).

Send Broadcast Macro in Header and Body

Example Send Broadcast Macro in Body

Below is a representation when using the WhatsApp broadcast API for sending a broadcast macro in the notification body.

When you enter the channel field using the channel id in the API, it will be like selecting an account on the application, as well as the templateId field like selecting the notification template. The name field will also be the title for your notification. The template variables field for the body will appear when you use a broadcast macro to fill in the values for the key, type, and value fields. SendingMode field is like specify the sending option to be used (if you use 'schedule', you can choose the time when the notification will be sent).

Send Broadcast Macro in Header and Body

Component Explanation:

Field
Description

Variables Object

Variables Object is required object for template that has macro. The object has key and value component

Key

This key refer to macro that available in broadcast template, example : {0}, {1}, {2}

Value

Value refer to field we define in recipient file, as shown below

Example of macro variable:

Example of recipient file (must be .xlsx format) :

In example above, field that being defined is Nama and Title. We can use this field on our Header Variables/Body Variables.

Body:

Method
POST

Media Type

application/json

URL

https://[server]/dolphin/apiv1/graph/broadcast

Header

Authorization : Bearer [generatedToken]

Body:

{
    "name":"your-broadcast-name",
    "channel":"channel-used-for-broadcast",
    "sendingMode":"sending-mode",
    "scheduledDate":"2021-01-01 23:30:334",
    "templateId" : "wa-template-id", 
    "recipient": "recipient-id",  
    
    "headerVariables" : [ 
        {"key": "{{1}}", "value": "Nama"}
     ],
    "bodyVariables" : [
        {"key": "{{1}}", "value": "Nama"},  
        {"key": "{{2}}", "value": "Tanggal"}
     ],
    "content" : [ 
    
    ]
}

Response:

Response status: 200

Response status: 200

{
  "status": "success",
  "data": {
    "id": "[broadcast-id]"
  },
  "message": "Successfully make Broadcast Item",
  "hasMore": false,
  "nextIndex": 0,
  "prevIndex": 0,
  "totalResults": 0
}

The example of headerVariables above has a meaning, you mapping value of field Name into macro {1} The example of bodyVariables above has a meaning, you mapping value of field Name into macro {1} and value of field Tanggal into macro {2}.

When broadcast being send into the recipient macro {1} and {2} would be replaced with the value from recipient file. In this example, the macro would be replaced with M.Ridwan and 22-04-2021. So the end result would be like this:

When broadcast being send into the recipient macro {1} and {2} would replaced with the value from recipient file. On this example, the macro would replaced with M.Ridwan and 22-04-2021. So the end result would be like this:

Halo, M.Ridwan

Terima kasih sudah mendaftarkan diri anda. Berikut lampiran datanya Nama: M. Ridwan Tanggal keberangkatan: 22-04-2021

Example Send Broadcast Macro in Header and Body

Below is a representation when using the WhatsApp broadcast API for sending a broadcast macro in the notification header and body.

When you enter the channel field using the channel id in the API, it will be like selecting an account on the application and the templateId field like selecting the notification template. The name field will also be the title for your notification. The template variables field for header and body will appear when you use a broadcast macro to fill in the values for the key, type, and value fields. SendingMode field is like specifying the sending option to be used (if you use 'schedule', you can choose when the notification will be sent).

Send Multiple Broadcast

Example Send Broadcast Macro in Header and Body

Below is a representation when using the WhatsApp broadcast API for sending a broadcast macro in the notification header and body.

Body for Multiple Broadcast:

When you enter the channel field using the channel id in the API, it will be like selecting an account on the application and the templateId field like selecting the notification template. The name field will also be the title for your notification. The template variables field for header and body will appear when you use a broadcast macro to fill in the values for the key, type, and value fields. SendingMode field is like specifying the sending option to be used (if you use 'schedule', you can choose when the notification will be sent).

Send Multiple Broadcast

Multiple broadcast allows you to create more than one broadcast at once.

Method
POST

Media Type

application/json

URL

Header

Authorization: Bearer [generatedToken]

Body for Multiple Broadcast:

[ 
*code for first broadcast request
{ 
   "name":"your-broadcast-name", 
   "channel":"channel-used-for-broadcast", 
   "sendingMode":"sending-mode",
   "scheduledDate":"2021-01-01 23:30:334",
   "content" : [ 
     { 
        "type" : "text", 
        "message": "First broadcast" 
      } 
   ] 
},
*code for second broadcast request
{ 
   "name":"your-broadcast-name", 
   "channel":"channel-used-for-broadcast", 
   "sendingMode":"sending-mode",
   "scheduledDate":"2021-01-01 23:30:334",
   "content" : [ 
     { 
        "type" : "text", 
        "message": "Second broadcast" 
      } 
   ] 
}
]

Response:

Response status: 200

Response status: 200

{
  "status": "success",
  "data": [
    {
      "id": "[id]",
      "message": "Successfully make Broadcast Item",
      "status": "success"
    },
     {
      "id": "[id]",
      "message": "Successfully make Broadcast Item",
      "status": "success"
    }
  ],
  "hasMore": false,
  "nextIndex": 0,
  "prevIndex": 0,
  "totalResults": 0
}

Get Broadcast Detail by ID

Method
GET

Media Type

application/json

URL

Header

Authorization : Bearer [generatedToken]

Broadcast id: [broadcast id]

Response:

Response status: 200

Response status: 200

{
    "status": "success",
    "data": {
        "id": "your-broadcast-id",
        "spell": [
            "New Notification",
            "{\"header\":[],\"body\":[{\"type\":\"static\",\"key\":\"{{1}}\",\"value\":\"{value}\"},{\"type\":\"static\",\"key\":\"{{2}}\",\"value\":\"{value}\"}]}"
        ],
        "owner": "owner-id",
        "createdDate": 1614657234000,
        "createdBy": "created-by-id",
        "modifiedDate": 1614657340548,
        "modifiedBy": "system",
        "templateId": "template-id",
        "actionDate": 1614657339000,
        "name": "New Notification",
        "message": "{\"header\":[],\"body\":[{\"type\":\"static\",\"key\":\"{{1}}\",\"value\":\"{value}\"},{\"type\":\"static\",\"key\":\"{{2}}\",\"value\":\"{value}\"}]}",
        "recipient": [
            "{\"type\":\"contact\",\"id\":\"{recipient-id}\",\"phone\":\"{phone-number}\",\"selected\":true}"
        ],
        "status": "Sent",
        "channel": "your-channel-id",
        "channelType": "your-channel-type",
        "sendingMode": "Now",
        "scheduledDate": 1614657339000,
        "scheduledTime": "10:55"
    },
    "hasMore": false,
    "nextIndex": 0,
    "prevIndex": 0,
    "totalResults": 0
}

Create Broadcast WhatsApp

Broadcast template id must be created first in order to use WhatsApp broadcast API.

Method
POST

Content Type

application/json

URL

Header

Authorization : Bearer [generatedToken]

Body:

{
  "name": "string",
  "recipient": "string",
  "status": "string",
  "channel": "string",
  "sendingMode": "string",
  "templateId": "string",
  "scheduledDate": "string",
  "botId": "string",
  "dialogId": "string",
  "content": [
    {
      "type": "string",
      "url": "string",
      "message": "string",
      "thumbnailUrl": "string"
    }
  ],
  "headerVariables": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "bodyVariables": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "whatsappRecipient": [
    {
      "Recipient": "string"
    }
  ]
}

Response:

Response Status: 200

{
    "name": "your-broadcast-name",
    "channel": "channel-used-for-broadcast",
    "sendingMode": "Now",
    "templateId": "wa-template-id",
    
    "bodyVariables": [
        {
            "type": "personalized",
            "key": "{{1}}",
            "value": "Nama"
        },
        {
            "type": "personalized",
            "key": "{{2}}",
            "value": "Title"
        }
    ],
    "content": [
        
    ],
    "whatsappRecipient": [
        {
            "Recipient": 6282xxxxxxxxx,
            "Nama": "ardian",
            "Title": "kak"
        },
        {
            "Recipient": 6282xxxxxxxxx,
            "Nama": "doni aprr",
            "Title": "kak"
        }
    ]
}
PreviousMarketing APINextLine Broadcast

Last updated 2 years ago

Was this helpful?

https://[server]/dolphin/apiv1/graph/broadcast/upload/recipient

https://[server]/dolphin/apiv1/graph/broadcast/verify/{your-channel-id}

https://[server]/dolphin/apiv1/graph/broadcast/multiple

https://[server]/dolphin/apiv1/graph/broadcast/detail

https://[server]/graph/broadcast/whatsapp

recipient-import-document.xlsx
Send Broadcast Text
Send Broadcast Text
Send Broadcast Image
Send Broadcast Image
Send Broadcast Video
Send Broadcast Video
Send Broadcast Document
Send Broadcast Document
Send Broadcast Quick Reply
Send Broadcast Quick Reply
Macro Variable
recipient-file.xlsx
Send Broadcast Macro in Body
Send Broadcast Macro in Body
Macro Variable
recipient-file.xlsx
Example Send Broadcast Macro in Header and Body
Send Broadcast Macro in Header and Body