3Dolphins
5.1 ID
5.1 ID
  • Get Started
  • Pre-Requisite
  • FAQ User
    • User Management
      • Apa yang Dilakukan Jika User Masih Memiliki Active Session?
      • Apa yang Harus Dilakukan Jika User Terkunci?
    • Ticket Management
      • Apa yang Harus Dilakukan Jika Tiket Tidak Masuk ke Tab Inbox?
    • Bot Settings
      • Apa yang Harus Dilakukan Jika Bot Tidak Ada Respon?
      • Apa yang Harus Dilakukan Jika Bot Tidak Merespons Seperti Yang Diharapkan?
    • Data Settings
      • Apa App Server, Web Server, dan Database yang Digunakan Oleh Chatbot 3Dolphins SRM?
      • Saat ChatBot Dijalankan di Linux. Proses Apa yang Running Untuk Menandakan Aplikasi Sedang Berjalan?
      • Jika Proses Mengalami Berhenti (fall) yang Tidak Normal. Apa yang Harus Dilakukan?
      • Bagaimana Cara Memantau 3rd-Party Service?
      • Tentang Performance Monitoring. Bisakah Dipantau dan Apakah Memiliki Dashboard?
      • Apa yang Perlu di-Backup?
      • Bagaimana Cara Backup Solr? Apakah Ada Menu dari Aplikasi Untuk Melakukan Backup?
      • Siklus Backup Apa yang Digunakan? Full atau Incremental?
      • Data Apa Saja yang Disimpan di Server?
      • Prosedur Data Housekeeping dan Technical Guideline. Apakah Ada Menu di Apps?
      • Cara Mengkonversi Field Milliseconds API Menjadi Format Date Apache Solr Menggunakan 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
      • User
      • Blocked
      • Active
      • Upload
      • Dual Control
      • Team Collaboration Chat
    • System Settings
      • 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
        • Default Sorting Mode
        • Word Sensor on Live Agent Message
        • Auto Greeting
        • Group Ticket Distribution
        • 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
      • Deal 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
    • Chanel Connector
      • Telegram Bot
        • Create Telegram Bot
        • Create a New Channel Telegram Bot
        • Create New Rule
        • Attach Bot
        • Start Chat
      • Email Inbox
        • Create a New Email Inbox Channel
        • Gmail Settings
        • Create New Rule
        • Reply Email
        • Forward Email
      • Live Chat
        • Create a New Channel of Live Chat
        • How to Connect Client to Live Chat Channel
        • Create New Rule
        • Live Chat Message
        • Live Chat Capabilities
        • Memasukkan Live Chat pada Website / Mobile (Webview) Anda
          • Website
          • Mobile (Webview)
        • Live Chat SDK for React Native
      • Telegram Account
        • Create a New Telegram Account
        • Create a New Channel of Telegram Account
        • Create New Rule
        • Attach Bot
      • Twitter
        • Twitter Developers Page
        • Create an App in Twitter Developer
        • Create a New Channel of Twitter
        • Create New Rule
        • Result of Create New Twitter Channel
        • Best Practice Twitter
          • Customer
          • Agent (Operator) atau Supervisor
        • Twitter Gateway
      • Facebook
        • Facebook Developers
        • Verify Your Bussiness
        • How to Create Facebook App
          • Change Additional Information About the App
          • How to Add Facebook Login Platform to Your Facebook App
          • How to Add Messenger Platform to Your Facebook App
          • Permission And Feature
        • Create New Page on Facebook
        • Create a New Channel of Facebook
        • How to Add Webhook 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) dan Supervisor
        • Facebook Gateway
      • WhatsApp Business API
        • How to Set Up Whatsapp Business
        • Create New Whatsapp Channel
        • How to Add New Whatsapp Channel Rule
      • Instagram Business
        • How to Register as a Facebook Developers
        • Go To Developers Facebook
        • Verify Your Bussiness
        • How to Create Facebook App
          • Change Additional Information About the App
        • How to Add Facebook Login Platform to Your Facebook App
        • Change Status Development Mode Into Public
        • How to Create New a Instagram Business Channel
        • How to Add “Webhooks” Platform to Your Facebook App
        • How to Add “Instagram” Platform to Your Facebook App
        • How to Add Permissions and Feature
        • How to Create a New Instagram Business Channel Rule
        • Result of Create New Instagram Business Channel
        • Best Practice Instagram
        • Instagram Gateway
      • Line Account
        • Create New Line Official Account
        • Create Line Developer
        • Create a New Channel of Line Account
        • Create New Rule
        • Result of Create New Line Account Channel
      • Skype
        • Create a Bot With Microsoft Bot Framework and Microsoft Azure
        • Create a New Channel of Skype
        • 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 New Ticket on App Follow
      • YouTube
        • Create a New Channel on YouTube
        • Create YouTube API Credentials
        • Create a New Channel of YouTube
        • Create New Rule
        • Result of Create New Channel YouTube
      • Smartcall
        • Create a New Channel of Smartcall
        • Add Telephony Credentials
        • Create New Rule
        • Result of Create New Channel Smartcall
    • Live Chat Designer
      • New Design
        • Style
        • Live Chat Connection
        • On Boarding Form
        • Livechat Label
        • Messaging Setting
      • Member Mode
      • Queue
      • Error Message
      • Voice and Speech
      • Campaign
      • Service Hour
      • Generate Script
      • View Script Widget
      • Edit Widget
      • Remove Widget
    • Third-Party Integration
  • Employee
    • Operator Shift
      • Add New Shift
      • Edit an Existing Shift
      • Assign Operator Shift
      • 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)
  • Marketing
    • Public Post
      • Create New Public Post
        • Upload File
        • Schedule, Post, and Draft
      • Filter dan Search
    • Notification
      • Create Notification
        • Account & Recipients
        • Message
        • Send or Schedule
      • Filter and Search Notification
      • Edit and Delete Notification
    • Template
      • Request 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
    • Maker Checker
      • Public Post Maker
      • Public Post Checker
      • Notification Maker
      • Notification Checker
  • Sales Activity
    • Lead
      • Create New 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
      • Transfer Deal to Another Pipeline
      • Pipeline
        • Add New Pipeline
        • Edit Pipeline
        • Delete Pipeline
      • Filter, Sort, and Search
      • Advanced Setting
      • Closed Deal to Won or Lost Deal
      • Delete Deal
    • Company
      • Create New Company
      • Detail Company
      • Search Company and Configuration Table
      • Delete Company
    • 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
    • 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
    • Kata Pengantar
    • 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
    • Customer Contact
      • Create New Contact
      • Edit Contact
      • Case Timeline
      • Chat History
      • Merge Contact
      • Merge Contact Suggestion
      • Send Email Message
      • Block Contact
      • Remove Contact
    • Ticket Automation
      • Komponen Automation
      • Tag, Severity, dan Process Flow
      • On Idle Trigger Ticket
      • Auto Greeting dengan Respon Berbasis Waktu
      • Bypass Distribusi Tiket untuk Pelanggan dengan Profil Tinggi
    • Rule Management
      • Add New Rule
      • Add Team Member
      • Add Rule Criteria
      • Configuration Rule
        • SLA Settings
        • Assignment
        • Service Hours
      • Clone Rule
      • Remove Rule
      • Filter Rule
      • Reload Rule
    • Form Management
      • Form Records
        • Filter Form Records
        • Download Form Record
      • Form Builder
        • Create New Form Builder
          • Settings
          • Generate Link
        • Edit Form Builder
        • Remove Form Builder
    • Paragraph Classifier
      • Add New Classifier Module
      • Add New Classifier
      • Add Tag to Chat Ticket
      • Edit Classifier
      • Remove Classifier
    • Email Template
      • New Email Template
      • Edit Email Template
      • Remove Email Template
      • Email Signature
      • Auto-Reply
    • Auxiliary Mapping
      • Create a New Agent Status
      • Edit an Existing Agent Status
      • Remove Agent Status
  • Quality Assurance
    • Performance Rating
      • Add Appraisal
      • Transfer Appraisal Report
      • Change Appraisal Report
      • Filter Ticket
    • Feedback Template
      • Create New Feedback Question
        • Agent Rating Survey
        • NPS Survey
      • Activate Feedback Template
      • Edit an Existing Feedback Template
      • Delete Feedback Template
    • Customer Feedback
    • 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 Flow
      • 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
      • Remove Workflow
      • Workflow Log
    • Dialog Flows
      • Create New Dialog
        • Intention and Entity
        • Prompt Response
        • Integration
        • Configuration
        • Build Dialog Model
        • Test the Dialog on Bot Emulator
      • Search and Filter Dialog
      • Switch Dialog
      • Change Contact Name
      • Get Customer
      • Get User Token
      • API Configuration
      • 3Dolphins SRM Bot Macro Commands
      • JSON Body Request for 3Dolphins SRM Dialog Rest Integration
      • JSON Body Response for 3Dolphins SRM Dialog Rest Integration
    • FAQ Knowledge
      • Create New FAQ Knowledge
      • FAQ Knowledge Contextual
      • How to Show Fallback
      • Remove, Edit and Clone Knowledge
      • Search and Filter Knowledge
      • Macro First Name and Last Name
    • 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 Page as JSON Format
      • Remove Page Builder
    • Payment Library
      • Add New Payment
      • Edit Payment Libarary
      • Delete Payment Library
    • Think Paragraph
      • Add Document (Article)
      • Edit Document (Article)
      • Ask Question Article
      • Delete Document (Article)
      • Think Paragraph Configuration
  • Analytic
    • Live Agent
      • Conversation History
      • Appraisal Report
      • Channel Interaction
      • Channel Group SLA
      • Live Agent SLA
      • Live Agent Performance
      • Live Agent Productivity
      • Live Agent Rating
      • Customer Rating
      • Visitor Volume
      • Bot Visitor Volume
      • Conversation Audit
      • User Access Audit
      • User AUX Audit
      • Net Promotor Score
      • Datetime Configuration
      • Create New Service Analytics
    • Virtual Agent
      • Bot Overview
        • Intent Data
        • Intent Score
      • Bot Engagement
      • Business Service
      • Intents Fallback
      • User Transaction
    • Employee
      • Operator Target
      • Attendance Report
      • Task Report
    • Sales
      • Deal Progress
      • Deal Conversion
      • Deal Overdue
      • Deal Won
      • Deal Lost
      • Filter Report
      • Download Report
    • WhatsApp
    • Wallboard
      • Wallboard Channel
      • Wallboard Agent
      • Wallboard Classifier
      • Wallboard Configuration
  • API
    • Service API
      • Ping API
      • Get Token
      • Auxilliary 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
      • Get 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
Powered by GitBook
On this page
  • Http Header
  • HTTP Body
  • HTTP Response

Was this helpful?

  1. Bot Settings
  2. Process Flow
  3. Component of Workflow

HTTP Request

PreviousExecute CommandNextMVEL Function

Last updated 4 years ago

Was this helpful?

Anda dapat mengirimkan request pada process flow untuk menyambungkannya pada API yang Anda gunakan atau mengintegrasikan dengan API third-party.

Http Header

Jika Anda memiliki request yang ingin Anda jalankan, Anda perlu mengetahui method, URL, serta value dan key opsional lainnya. Pilih HTTP Request pada daftar command kemudian akan ditampilkan sebagai gambar di bawah.

Penjelasan komponen :

Komponen

Deskripsi

Nama Http Request

node_id pada komponen workflow.

Method

Method dari HTTP Request mensupport GET, POST, PUT, DELETE, dan PATCH.

URL

API yang ingin Anda hit (link yang ingin Anda akses). URL bersifat dynamic, URL dapat menggunakan parameter, tergantung oleh variable yang akan ditampilkan.

Key

Nama variable (dapat menggunakan parameter yang tidak harus statis).

Value

Value dari variable (dapat menggunakan parameter yang tidak harus statis).

+ HTTP Header

Button untuk menambahkan header (key dan value).

Play

Untuk mengeksekusi node_id yang telah dibuat.

Add

Untuk menyimpan node_id padaworkflow.

A. Request Methods

Saat ini, terdapat 5 method yang dapat Anda gunakan untuk mengambil data dari API pada process flow, yaitu GET, POST, PUT, DELETE, and PATCH.

B. Setting Request URLs

Setiap request yang Anda kirim pada process flow membutuhkan URL yang merepresentasikan endpoint dari API yang Anda gunakan. Tiap operasi yang dapat Anda tampilkan menggunakan API biasanya terkait dengan endpointnya. Tiap endpoint dalam API tersedia pada particular URL, inilah yang Anda masukkan pada process flow untuk akses API.

Jika Anda membuat sebuah API, URL biasanya menjadi lokasi dasar dan pathnya. Sebagai contoh:

Deskripsi dari URL :

1. {URL} : Digunakan untuk meneruskan informasi ke destinasi.

2. {Path} : Lokasi data pada server.

Jika Anda menggunakan third-party API, provider API Anda akan menyediakan URL yang Anda butuhkan, sebagai contoh dalam dokumentasi developer mereka.

Anda dapat mengetikkan query parameter secara optional ke kolom URL. Kata apapun setelah tanda tanya (?) pada URL dianggap sebagai parameter yang dapat menyimpan values. Value untuk parameter yang sesuai diberikan setelah simbol "equals" (=). Beberapa parameter dapat dikirimkan melalui URL dengan memisahkannya dengan menambahkan "&". Sebagai contoh:

URL menyediakan variable dinamis yang dapat Anda gunakan pada request Anda. Tiap nama variable mewakili key, jadi mereferensikan nama variable mengijinkan Anda untuk mengakses valuenya. Nama variable biasanya diambil dari proses sebelumnya.

Perhatikan contoh workflow berikut ini.

Pada gambar diatas (Process Flow ‘Kurs Mata Uang’), kita ambil contoh dari proses ‘getKurs'. Proses ini untuk menyediakan respon feedback pada request yang dikirim.

${getEntity.response} variable ini berisi response dari proses ‘getEntity’. Atau, Anda dapat menambahkan ${getEntity.response} menggunakan response (output) dari proses ‘getEntity’, seperti pada gambar berikut ini.

Perhatikan contoh workflow berikut ini.

Pada gambar diatas (Add Gitlab Issue Workflow), kita ambil contoh dari proses ‘addGitlabIssue’. Proses ini adalah untuk menyediakan respon feedback dari request yang dikirim, respon ini ada pada form dari object 'title' dimana valuenya adalah ${response.title}. Variable ${response.title} ini berisi response title dari proses ‘transformIssue’.

Variable ${response.title} tidak akan bisa diproses pada 'getChatLink'. Karena, sebelum proses 'getChatLink' terdapat 2 proses yaitu 'addGitlabIssue' dan 'getToken', saat Anda memasukkan variable ${response.title} pada 'getChatLink', sistem akan bingung untuk menentukan title variable untuk ditampung, baik variabel yang akan ditampung merupakan response dari proses 'addGitlabIssue' ataupun response dari proses 'getToken'.

C. Setting Request Header

Beberapa API mengharuskan Anda untuk mengirim header tertentu bersama dengan request, biasanya untuk menyediakan metadata tambahan tentang operasi yang Anda tampilkan. Anda dapat mengaturnya di tabel Header. Masukkan pasangan key-value yang Anda butuhkan dan process flow akan mengirim mereka bersama dengan request Anda. Variable memungkinkan Anda untuk menyimpan dan menggunakan kembali value pada request Anda. Menggunakan variabel meningkatkan kemampuan Anda untuk bekerja secara efisien dan meminimalkan kemungkinan error.

Sebagai contoh, untuk menyertakan otorisasi pada request header, Anda dapat menentukan header pada request node id 'getToken', request ini berfungsi untuk mengambil variable token dari API yang terdapat dalam URL dan akan menampung variable sebagai response.

Untuk mendapatkan token dari aplikasi 3Dolphins, request body pada form 3Dolphins account harus diisi. Fungsi akun 3Dolphins ini sebagai autentikasi pada API Rest, jadi hanya user 3Dolphins yang dapat menggunakan API 3Dolphins.

Saat request dieksekusi, kemudian response akan diperoleh dari form dari akses token.

Pada gambar diatas (Gambar Add Gitlab Issue Workflow), kita ambil contoh dari proses 'getChatLink'. Proses ini menyediakan response feedback untuk request yang dikirim, response ini berada di form object 'Authorization' yang valuenya adalah ‘${getToken.response.token}’. Variable ‘${getToken.response.token}’ ini berisi token response dari proses 'getToken'.

HTTP Body

Tab ‘HTTP Body’ dalam process flow memungkinkan Anda menentukan data yang perlu Anda kirim dengan request. Anda dapat mengirim berbagai jenis data body untuk disesuaikan dengan API Anda.

Jika anda mengirim data body, pastikan Anda memiliki header yang sesuai untuk menunjukkan tipe konten API Anda mungkin butuh untuk memproses dan menerima data secara benar. Biasanya Anda akan menggunakan data body dengan request POST.

Pada gambar Add Gitlab Issue Workflow, kita ambil contoh dari proses 'getToken'. Untuk mendapatkan akses token membutuhkan request body seperti akun 3Dolphins. Akun 3Dolphins ini berfungsi sebagai autentikasi pada API Rest, jadi hanya user 3Dolphins yang dapat menggunakan API 3Dolphins.

HTTP Response

Setelah header dan detail request lainnya disiapkan, Anda dapat mengklik Play untuk menjalankan request Anda dan memeriksa respons yang diterima dari server API. Jika request Anda tidak bekerja seperti yang diharapkan, periksa beberapa error.

Pada gambar Add Gitlab Issue Workflow diatas, kita ambil contoh dari proses 'addGitlabIssue', agar dapat menambahkan issue pada gitlab, kita butuh destinasi URL (server API) dan parameternya akan dikirim ke gitlab. Sebagai contoh pada proses 'addGitlabIssue', parameter yang akan dikirim adalah title, description, dan label. Saat proses 'addGitlabIssue' berjalan, anda akan mendapat response (response ini akan dikirim ke gitlab) seperti gambar dibawah ini.

HTTP Header
Process Flow 'Kurs Mata Uang'
Add Gitlab Issue Workflow
Add Gitlab Issue - HTTP Header
Get Token - HTTP Header
Get Token - HTTP Body
Get Token - HTTP Response
Get Chat Link - HTTP Header
Get Token - HTTP Body
Add Gitlab Issue - HTTP Response