AntBuddy Vietnam
  • Tài liệu AntBuddy - Hướng dẫn sử dụng (AntBuddy Docs - User Guide)
    • Hướng dẫn đăng ký và thanh toán (Guide to Register and Payment)
      • Đăng ký và Đăng nhập (Register and Login)
        • 1. Đăng ký (Register)
        • 2. Đăng nhập (Log in)
      • Thanh toán (Payment)
    • Quản trị khách hàng AntCrm (AntCrm Customer Management)
      • Cài đặt (Settings)
        • Tạo nhân viên (Create users)
        • Tạo nhóm (Create group)
        • Mời nhân viên vào công ty (Invite users to the company)
        • Quyền xem (View permissions)
        • Quyền hoạt động (Activity permissions)
        • Ticket là gì? Cách tạo mới Ticket? (What is Ticket? How to create Ticket?)
          • Thao tác với Ticket (Operations with Ticket)
        • Thao tác với task (Operations with task)
        • SLA là gì? Sử dụng SLA như thế nào?(What is SLA? How to use SLA?)
        • What are Lead, Contact, Account? How to create Lead, Contact, Account?
        • Lead, Contact, Account là gì? Cách tạo mới Lead, Contact, Account?
        • Hướng dẫn sử dụng tính năng tự động gửi tin nhắn SMS/ZNS khi có cuộc gọi nhỡ
        • Cách sử dụng tính năng Giới hạn số phiên hội thoại tối đa cho từng nhân viên
      • Tin nhắn đa kênh (Conversation)
        • Hướng dẫn sử dụng Omni Facebook (Omni Facebook user guide)
          • 1. Tích hợp Facebook (Facebook integration)
            • 1.1 Truy cập vào trang tích hợp Facebook (Access the Facebook Integration Page)
            • 1.2 Dùng tài khoản admin để tích hợp (Use the Admin account of the page to integrate)
          • 2. Thiết lập Fanpage Facebook (Setting Up Facebook Fanpage)
            • 2.1 Thêm hỗ trợ (Adding Support)
            • 2.2. Cấu hình phân công (Assignment Configuration)
            • 2.3. Cấu hình tương tác (Interaction Configuration)
          • 3. Quản lý tin nhắn (Message Management)
            • 3.1 Gửi tin nhắn (Sending Message)
            • 3.2 Xem lịch sử hội thoại (Viewing Conversation History)
          • 4. Quản lý comment (Comment Management)
            • 4.1 Bình luận chăm sóc khách hàng (Customer Support Commenting)
            • 4.2 Cách ẩn bình luận (Hiding comments)
            • 4.3 Chỉnh sửa bình luận (Editing comments)
            • 4.4 Xóa bình luận (Deleting comments)
            • 4.5 Thích/Bỏ thích bình luận (Liking/Unliking Comments)
          • 5. Quản lý bài Post (Post Management)
          • 6. Thay đổi người phụ trách session (Changing the Session Owner)
          • 7. Thêm user hỗ trợ (Adding support user)
          • 8. Gắn nhãn session (Tagging session)
          • 9. Gửi hình ảnh (Sending images)
          • 10. Đánh dấu Xong (Marking done)
          • 11. 𝑇ℎ𝑒̂𝑚 𝑚𝑎̂̃𝑢 𝑡𝑖𝑛 𝑛ℎ𝑎̆́𝑛 (𝐴𝑑𝑑𝑖𝑛𝑔 𝑚𝑒𝑠𝑠𝑎𝑔𝑒 𝑡𝑒𝑚𝑝𝑙𝑎𝑡𝑒)
            • 11.1. Thêm sửa xóa templates (Add/Edit/Delete templates)
            • 11.2. Sử dụng mẫu tin nhắn (Using message template)
          • 12. Thiết lập thời gian đóng session (Setting Up Session Timeout)
          • 13. Cấu hình thời gian chờ (Configuring the Timeout)
          • 14. Thiết lập tự động trả lời và gửi tin nhắn (Setting Up Auto-Reply and Sending Messages)
          • 15. Thiết lập thời hạn phản hồi và cảnh báo (Setting Up Response Time and Pre-Expiration Warnings)
          • 16. Các thao tác với khách hàng (Customer operations)
          • 17. Đánh dấu chưa đọc (Marking unread)
          • 18. Thiết lập Danh mục hội thoại (Setting up Omnichannel chat Categories)
          • 19. Cấu hình hiển thị (Configuring layout)
        • Hướng dẫn sử dụng Zalo OA (Zalo OA user guide)
          • 1. Tích hợp Zalo OA (Zalo OA integration)
          • 2. Thiết lập trang (Setting page)
            • 2.1. Thêm User hỗ trợ (Add user support)
            • 2.2. Tính năng phân phối tự động và Assignment Mode (Auto assign feature and Assignment Mode)
            • 2.3. Cấu hình gắn thẻ cho khách hàng mới (Configure tagging for new customers)
            • 2.4. Cấu hình Nguồn Lead (Configure lead source)
          • 3. Quản lý tin nhắn (Message Management)
            • 3.1. Gửi tin nhắn(Sending message)
            • 3.2. Xem lịch sử hội thoại (Viewing Conversation History)
          • 4. Thay đổi người phụ trách cho session (Changing the Session Owner)
          • 5. Thêm user hỗ trợ (Adding support user)
          • 6. Gắn nhãn (Tags)
          • 7. Gửi hình ảnh (Sending images)
          • 8. Đánh dấu Xong (Marking done)
          • 9. Thêm mẫu tin nhắn (Adding Message Template)
            • 9.1. Thêm/sửa/xóa (Add/Edit/Delete)
              • 9.1.1. Thêm mẫu tin nhắn (Adding a Message Template)
              • 9.1.2. Chỉnh sửa mẫu tin nhắn (Editing message template)
              • 9.1.3. Xóa mẫu tin nhắn (Deleting message template)
            • 9.2. Sử dụng mẫu tin nhắn (Using message template)
          • 10. Thiết lập thời gian đóng session (Setting Up Session Timeout)
          • 11. Cấu hình thời gian chờ (Configuring the Timeout)
          • 12. Thiết lập thời hạn phản hồi và cảnh báo (Setting Up Response Time and Pre-Expiration Warnings)
          • 13. Đánh dấu chưa đọc (Marking unread)
          • 14. Thiết lập Danh mục hội thoại (Setting up Omnichannel chat Categories)
          • 15. Cấu hình Cấu hình hiển thị (Configuring layout)
        • Hướng dẫn sử dụng Instagram (Instagram use guide)
          • 1. Tích hợp Instagram (Instagram integration)
          • 2. Sử dụng hội thoại đa kênh Instagram (Using Instagram Omni conversations)
            • 2.1. Thiết lập Instagram trên AntCRM (Guide to setting up Instagram on AntCRM)
              • 2.1.1. Thêm hỗ trợ (Adding support)
              • 2.1.2. Cấu hình phân công (Assignment configuration)
              • 2.1.3. Cấu hình tương tác (Interactive Configuration)
          • 3. Quản lý chat với khách hàng (Manage chat with customers)
            • 3.1. Gửi tin nhắn cho khách hàng (Send message to customer)
            • 3.2. Xem lịch sử hội thoại (View session history)
          • 4. Quản lý comment (Comment Manager)
            • 4.1. Ẩn bình luận (Hide comment)
            • 4.2. Xóa bình luận (Delete comment)
          • 5. Thay đổi người phụ trách session (Change the person assign to session)
          • 6. Thêm user hỗ trợ (Adding user support)
          • 7. Gắn nhãn session (Tags for session)
          • 8. Gửi hình ảnh (Send image)
          • 9. Đánh dấu xong (Mark as done)
          • 10. Thêm mẫu tin nhắn (Adding message template)
            • 10.1.Thêm/sửa/xóa template (Add/Edit/Delete template)
            • 10.2.Sử dụng mẫu tin nhắn (Using messenger template)
          • 11. Thiết lập thời gian đóng session (Setting up session timeout)
          • 12. Thiết lập thời hạn phản hồi và cảnh báo (Setting Up Response Time and Pre-Expiration Warnings)
        • Hướng dẫn sử dụng whatsapp (Whatsapp use guide)
          • 1. Tích hợp whatsapp vào CRM (Integrate whatsapp on CRM)
          • 2. Thiết lập whatsapp trên CRM (Setting whatsapp on CRM)
            • 2.1. Thêm user hỗ trợ (Adding user support)
            • 2.2. Thiết lập đóng hội thoại (Setting close session)
            • 2.3. Cấu hình phân công (Assignment Configuration)
            • 2.4. Cấu hình tương tác (Interaction Configuration)
          • 3. Quản lý chat với khách hàng whatsapp (Managing Chats with Whatsapp Customers)
            • 3.1. Gửi tin nhắn (Send message)
            • 3.2. Xem lịch sử phiên hội thoại (Viewing Conversation History)
            • 3.3 Thay đổi nhân viên phụ trách phiên hội thoại (Changing the Session's Assigned Agent)
          • 4. Thêm user hỗ trợ (Adding a Support User)
          • 5. Mục Tag (Tagging a Session)
          • 6. Gửi hình ảnh (Sending image)
          • 7. Đánh dấu session đã xong (Marking a Session as Completed)
          • 8. Thêm, Sửa và Xóa mẫu tin nhắn (Adding, Edit and Delete omni message template)
          • 9. Thời gian đóng session (Session Closure Time)
          • 10. Cấu hình thời gian chờ (Configuring the wait time)
          • 11. Cài đặt thời gian phản hồi và cảnh báo (Setting response Time and Pre-expiration Alerts)
          • 12. Tạo chiến dịch SMS whatsapp (Creating Whatsapp SMS campaign)
          • 13. Gửi chiến dịch SMS whatsapp (Sending Whatsapp SMS Campaign)
          • 14. Gửi Carousel Sản Phẩm (Sending the Product Carousel)
          • 15. Chiến lược đa kênh (Cross-Channel Campaign Guide)
            • 15.1. Tạo mẫu (Creating template)
          • 16. Tạo mẫu WhatsApp qua Meta Business Suite (Create WhatsApp Template via Meta Business Suite)
          • 17. Chạy mẫu trong nền tảng AntCRM (Run Template in AntCRM platform)
        • Hướng dẫn sử dụng Shopee (Shopee use guide)
          • 1. Tích hợp Shopee vào CRM (Integrate Shopee on CRM)
        • Hướng dẫn sử dụng Live chat (Live chat use guide)
        • Hướng dẫn sử dụng Lazada (Lazada use guide)
        • Cách thêm lý do tạm dừng nhận tin hội thoại đa kênh
      • Báo cáo (Report)
        • Hướng dẫn xem và truy xuất Báo cáo AntCRM (Instruction to view and retrieve AntCRM Reports)
          • 1. Báo cáo nhân viên (Users report)
          • 2. Báo cáo nhóm (Group report)
          • 3. Báo cáo khách hàng tiềm năng (Lead report)
          • 4. Báo cáo khách hàng (Customer report)
          • 5. Báo cáo giao dịch (Order report)
          • 6. Báo cáo Ticket (Ticket report)
          • 7. Báo cáo Lịch sử cuộc gọi (Call history report)
          • 8. Báo cáo Lịch sử gửi tin nhắn (Sending message history report)
          • 9. Báo cáo Quy trình tự động (Automation)
          • 10. Báo cáo KPI (KPI report)
        • KPI là gì? Xây dựng chỉ tiêu KPI như thế nào? (What is KPI ? How to build KPI targets? )
        • Xem báo cáo tin nhắn đa kênh (View Omnichannel conversation report)
        • Báo cáo điểm hài lòng (Satisfaction Report)
      • Quản lý trải nghiệm khách hàng (Customer Experience Management)
        • 1. Thiết lập khảo sát khách hàng (Customer survey setting)
          • 1.1. Tin nhắn đa kênh(Conversations)
          • 1.2. Tổng đài cuộc gọi(Call Center)
          • 1.3. Thiết lập tiêu chí đánh giá (Rating criteria setting)
          • 1.4. Cấu hình landing page (Setting landing page)
        • 2. Cách sử dụng trên giao diện tư vấn viên (How to use the Agent interface)
        • 3. Báo cáo điểm hài lòng (Satisfaction Report)
      • Hướng dẫn sử dụng chiến dịch (User manual for Campaign)
        • Làm sao để chạy quy trình Marketing Automation? (How to run Marketing Automation process ?)
        • Chiến dịch Telesales là gì? Làm thế nào để chạy chiến dịch Telesales? (Telesales user manual)
        • Hướng dẫn khởi tạo chiến dịch ZNS (Instructions to configure a ZNS campaign)
        • Hướng dẫn khởi tạo chiến dịch Social Facebook (Instructions for creating a Facebook Social campaign)
      • Sản phẩm (Product)
        • Hướng dẫn tạo sản phẩm trong giao dịch (Instructions to create products in order )
        • Hướng dẫn import hàng loạt sản phẩm (Instructions to import series of products)
      • Đơn hàng (Order)
        • Hướng dẫn tạo và quản lý giao dịch
        • Import đơn hàng (Import orders)
        • Cam kết SLA đơn hàng (Order SLA Commitment)
        • Lọc và tải về đơn hàng (Filter and download orders)
      • Khách hàng thân thiết (Loyalist)
        • Hướng dẫn tạo sản phẩm và mã thẻ cho sản phẩm (Instructions to create products and product codes)
    • Tổng đài AntRing (Antring Call Center)
      • Cài đặt (Setting)
        • Antbuddy PC
        • Điện thoại Yealink T19 E2 (Yealink T19 E2 phone)
        • IP Phone Grandstream GXP 1610
        • Reset Password dành cho quản trị viên (Reset password for administrators)
        • Chặn số quấy rối trên trang quản trị AntBuddy (Block spam numbers on the AntBuddy admin page)
        • Tạo người dùng trên Call Center (Create a user on Call Center)
      • Hướng dẫn cài đặt AntBuddy Callbar PC (Antbuddy PC installation guide)
      • Hướng dẫn cài đặt và sử dụng Mobile app AntBuddy (Guide to install and use Mobile App AntBuddy)
      • Cách xem báo cáo cụ thể của Antbuddy Call Center
        • 1. Lịch sử cuộc gọi (Call history)
        • 2. Tổng quan tổng đài
        • 3. Báo cáo hàng đợi
        • 4. Báo cáo nhân viên
        • 5. Bảng tổng quan TV
      • Hướng dẫn sử dụng tính năng chấm điểm cuộc gọi
      • Hướng dẫn tắt SIP ALG trên các dòng modem phổ thông (guide to turn off SIP ALG on popular modems)
      • Hướng dẫn Reset Password dành cho quản trị viên
    • Tài liệu hướng dẫn sử dụng AntBot ChatBot (User manual for AntBot ChatBot)
      • Hướng dẫn sử dụng FAQ
      • Tích hợp tin nhắn đa kênh với Chatbot AntBot
      • Các tính năng cơ bản của Chatbot AntBot (The basic features of AntBot Chatbot)
      • Các Trường Hợp Sử Dụng Chatbot AntBot (Use Cases of AntBot Chatbot)
      • Giải thích chi tiết về node Chatbot (Detailed explanation of the Chatbot node)
  • Hướng dẫn tích hợp API (Team technical) (API integration guide (technical team))
    • AntRing
      • Đăng ký API (API Registration )
      • Sử dụng API (Use API)
      • Danh sách API (API List)
      • Mã lỗi (Error code)
    • AntBot
      • AntBOT API
      • Voice OTP
      • HTTP Response
    • AntCRM
      • ApiRing AntCrm
        • 1. API get customer
        • 2. API get order
        • 3. API get product
        • 4. API get ticket
        • 5. Point accumulation API
        • 6. API get redeem
        • 7. API get segment
        • 8. API get list of survey
        • 9. API get list of telecalls
        • 10. API get campaign list
        • 11. API get rating list
        • 12. API get tags
Powered by GitBook
On this page
  • Tích hợp và sử dụng từ ứng dụng thứ 3​
  • Chiến dịch​
  • Appointment​
  1. Hướng dẫn tích hợp API (Team technical) (API integration guide (technical team))
  2. AntBot

AntBOT API

PreviousAntBotNextVoice OTP

Last updated 2 months ago

Tích hợp và sử dụng từ ứng dụng thứ 3

Mục đích

  • Cho phép sử dụng Alice từ ứng dụng thứ 3. Yêu cầu bắc buộc đã đăng ký và trial alice từ onboarding antbuddy.

  • Cho phép chạy chiến dịch từ ứng dụng thứ 3.

  • Tạo alarm cho 1 liên hệ (appointment)

API chi tiết

Tất cả API request tới hệ thống Alice:

Thông qua tên miền

https://alice.antbuddy.com/rest-api

Authorize header bắt buộc:

Authorization: Bearer {access_token}

Get AccessToken

Endpoint: /get-token/
Method: POST
Body: {
    "username": "username",
    "password": "password"
}

Description:
Username: Tên hoặc email đã tạo bên antbuddy
Password: Mật khẩu
Survey Template: /rest-api/campaigns/
Method: GET
Params: {
  "name": "NESHB"
  "phonebook": "732"
  "status" "1"
}
Description:
- name : Tìm kiếm theo tên 
- phonebook : Tìm theo danh bạ
- status : Tìm theo trạng thái của chiến dịch 
1 : Đã bắt đầu
2 : Đang đợi 
3 : Đang ngừng
4 : Đã kết thúc
5 : Đã hoàn thành

Cấu hình callflow cho chiến dịch

Create survey: /rest-api/survey-template/
Method: POST
Body: {
"name": "Tên survey",
"tts_language":  "vi",
"description": "anything"
}
Description:
- name : Tên mẫu khảo sát
- tts_language : Ngôn ngữ của mẫu khảo sát 
vi : Tiếng việt
en : Tiếng anh 
- description : Mô tả của mẫu khảo sát
Survey Template: /rest-api/survey-template/
Method: GET
Params: {
  "search": "template name"
  "description": "description"
  "is_onboarding" "true"
  "user": "203"
}
Description:
- search : Tìm kiếm theo tên 
- description : Tìm theo mô tả
- is_onboarding : 
- user : Tìm theo id người dùng
Create section: /rest-api/section-template/
Method: POST
Body: {
    "type": 1,
    "survey": ID of survey,
    "question": String (tên section),
    "script": Text (nội dụng ivr)
}

Update section: 
Endpoint: /rest-api//section-template/{id}/
Method: PUT
Body {
      "script" : "Vui lòng đợi trong giây lát."
}
Phonebook : /rest-api/phonebook/{id} (Tìm theo id)
Method: GET
Params: {
  "search": "name"
}
Description: 
- search : Tìm theo tên danh bạ
Contact : /rest-api/contact/{id} (Tìm theo id)
Method: GET
Params: {
  "phonebook" : "732"
  "search" : "0934523423"
}
Description: 
- phonebook : Tìm theo id của phonebook
- search : Tìm theo số điện thoại hoặc tên 
Create phonebook : /rest-api/phonebook/
Method: POST
Body: {
    "name": "name",
    "description": "rest phonebook" (option)
}

Description:
- name : Tên danh bạ
- description : Mô tả
Update phonebook: /rest-api/phonebook/{id}/
Method: PUT
Body: {
    "name": “changed name”,
    "description": “updated descrption" 
}
Description:
- name : Thay đổi tên
- description : Thay đổi mô tả
Create:  /rest-api/contact/
Method: POST
Body: {
    "phonebook": {phonebook_id} (required),
    "contact": "0934890883" (required),
    "email": "linh.huynh@htklabs.com" (optional),
    "last_name": "Huynh" (optional),
    "first_name": "Linh" (optional),
    "description": "khách hàng ABC" (optional),
    "status": 1 or 0 (1: active, 0: inactivate) (required),
    "additional_vars": "{\"params_1\":\"123456\",\"params_2\":\"123456\"}" (optional)
}
Update: /rest-api/contact/{id}/
Method: PUT
Body: {
    "contact": "0934890884",
    "status": 1,
    "country": "VN",
    "first_name": "A",
    "last_name": "B"
}
EndPoint: /rest-api/bulkcontact/
Method: POST
Body: {
  "phonebook": 293,
  "contacts": [
    {
      "contact": "0934890883",
      "email": "linh.huynh@htklabs.com",
      "last_name": "Huynh",
      "first_name": "Linh",
      "status": 1
    },
    {
      "contact": "0934890881",
      "email": "linh.huynh@htklabs.com",
      "last_name": "Huynh",
      "first_name": "Linh",
      "status": 1
    }
  ]
}
Gateway List (Endpoint: /rest-api/gateway/)
Method: GET
Response: {
  "results": [
    {
      "id": 23,
      "name": "AliceDevGateway",
      "status": 1,
      "description": "AliceDevGateway",
      "addprefix": "",
      "removeprefix": "",
      "gateways": "sofia/gateway/AliceDevGateway/",
      "subdomain": "company",
      "gateway_codecs": "",
      "gateway_timeouts": "10",
      "gateway_retries": "",
      "originate_dial_string": "",
      "secondused": null,
      "created_date": "2019-12-26T04:17:12.673711Z",
      "updated_date": "2020-01-14T03:12:27.079710Z",
      "addparameter": "",
      "count_call": 0,
      "count_in_use": null,
      "maximum_call": null,
      "is_trial": true,
      "failover": null
    }
  ]
}
Endpoint: /rest-api/campaigns/
Method: POST
Body Example: 
{
  "name": "rest-api-cp-2"
  "description": "rest api for campaign",
  "callerid": "lh",
  "phonebook": [
    293
  ],
  "aleg_gateway": 23,
  "object_id": 351,
  "frequency": 10,
  "startingdate": "2020-02-11T02:36:39.045000Z",
  "expirationdate": "2020-02-12T02:36:39.045000Z",
  "daily_start_time": "08:00:00",
  "daily_stop_time": "21:00:00"
}

Description:
- name: required,
- description: rest api for campaign (option),
- callerid: caller name when callout (option),
- phonebook: phone book IDs list (required),
- aleg_gateway:gateway dialout (required),
- object_id: survey template application (required),
- frequency: call per minute (required),
- startingdate: Starting date campaign (required),
- expirationdate: Stopped date campaign (required),
- daily_start_time: dialy time (required),
- daily_stop_time: dialy ending time(required)
Endpoint: /rest-api/campaigns/{id}/
Method: PUT
Body:
{
  "name": "rest-api-cp-2",
  "description": "rest api for campaign",
  "callerid": "rest_api",
  "phonebook": [
    293
  ],
  "frequency": 3,
  "startingdate": "2020-02-11T02:36:39.045000Z",
  "expirationdate": "2020-02-12T02:36:39.045000Z",
  "daily_start_time": "09:00:00",
  "daily_stop_time": "18:00:00"
}
Endpoint: /rest-api/campaigns/{id}/status/
Method: POST
Body: {
  "status": 1,
}

Description:
START = 1
PAUSE = 2
ABORT = 3
END = 4
Endpoint: /rest-api/campaigns/{id}
Method: DELETE
Endpoint: /rest-api/survey-list/
Method: GET
Params: {
  "search" : "test"
  "tts_language" : "vi"
  "description" : "Test"
  "campaign" : 1243
}

Description:
- search : Tìm theo tên 
- tts_language : Tìm theo ngôn ngữ
vi : Tiếng việt
en : Tiếng anh
- description : Tìm theo mô tả
- campaign : Tìm theo id của chiến dịch
Endpoint: /rest-api/dnc-list/
Method: GET
Endpoint: /rest-api/dnc-contact/
Method: GET
Endpoint: /rest-api/dnc-list/
Method: POST
Body: {
  "name" : "name dnc",
  "description" : "test"
}

Description:
- name : Tên DNC
- description : Mô tả
Endpoint: /rest-api/dnc-contact/
Method: POST
Body: {
  "phone_number" : "0324324343",
  "dnc" : "343"
}

Description:
- phone_number : Số điện thoại
- dnc : ID của DNC list
Endpoint: /rest-api/cdr/
Method: GET
Params: {
  "callid" : "res232-fsf3-sfdsf"
  "callerid" : "admin"
  "phone_number" : 094343434
  "from_date" : 2023-04-06T10:52:56.162517Z
  "to_date" : 2023-03-28T08:05:07.495988Z
  "duration" : 34
  "billsec" : 3
  "disposition" : FAILED
  "hangup_cause" : UNALLOCATED_NUMBER
  "sip_term_status" : 404
  "sip_term_cause" : 2
  "endpoint_disposition" : ANSWER
  "campaign" : 23
  "alarm" : false
  "otp" : true
}

Description:
- callid : Id cuộc gọi
- callerid : Id người gọi
- phone_number : Số điện thoại
- from_date : Thời điểm bắt đầu
- to_date : Thời điểm kết thúc
- duration : Thời lượng cuộc gọi
- billsec : 
- disposition : 
- hangup_cause : Lí do ngừng cuộc gọi
- sip_term_status : 
- sip_term_cause :
- endpoint_disposition :
- campaign : Id của chiến dịch
- alarm : Những cuộc gọi nhắc lịch
true : Những cuộc gọi nhắc lịch
false : Những cuộc gọi không nhắc lịch
- otp : Những cuộc gọi OTP
true : Những cuộc gọi OTP
false : Những cuộc gọi không phải OTP
Get subcribers : /rest-api/subscriber-list/
Method: GET
Params: {
  "campaign" : 2323
  "contact" : 094344334
  "status" : 2
  "duration" : 43
  "billsec" : 23
}

Description:
- campaign : Id của chiến dịch
- contact : Số điện thoại
- status : trạng thái
- duration : Thời lượng cuộc gọi
- billsec : 
Endpoint: /rest-api/calendar-setting/
Method: POST
Body: {
  "label": "rest-api-cp-2",
  "callerid": "mantest_calendarsettings",
  "caller_name": "",
  "call_timeout": 60,
  "survey": 953,
  "aleg_gateway": 23
}

Description:
- label: tên  (required),
- callerid: caller hiển thị (option),
- caller_name: tên người gọi (option),
- call_timeout: thời gian cuộc gọi timeout  bằng giây (required),
- survey": id của khảo sát (required), get from Survey List API
- aleg_gateway: cổng nối gọi ra (required),
  Get from Gateway List API
Endpoint: /rest-api/calendar-user/
Method: POST
Body:
{
  "username": "cal-rest-user-resp2",
  "password": "12345678" - required,
  "calendar_setting": 4 - required
}

Description:
- username: user login (required)
- calendar_setting: Calendar setting,
 GET from calendar-setting API
Endpoint: /rest-api/calendar/
Method: POST
Body: {
  "name": "linh-calendar-rest",
  "user": 5 - required
}
​
Description: 
- name: required  
- user: Calendar User List, 
Get from calendar-user API
Endpoint: /rest-api/event/
Method: POST
Body: {
  "title": "today-linhhv",
  "description": "",
  "start": "2020-02-15T09:30:39.177000Z",
  "end": "2020-02-15T10:13:39.177000Z",
  "creator": 115,
  "calendar": 7
}

Description:
- title: Tên sự kiện (required)
- start: Thời gian bắt đầu (required)
- end: Thời gian kết thúc (required)
- creator: calendar user được gắn vào, 
  được lấy từ calendar-user API
- calendar: Lịch gắn vô sự kiện, 
được lấy từ calendar API
Endpoint: /rest-api/alarm/
Method: POST
Body: 
{
  "alarm_phonenumber": "0934890883",
  "date_start_notice": "2020-02-12T02:49:33.572Z",
  "phonenumber_transfer": "",
  "event": 8
}

Description: 
- alarm_phonenumber: call to number (required),
- date_start_notice: starting date alarm - (option- default current time),
- phonenumber_transfer: phone to transfer (option),
- event: related event (required), event list get from event API, method Get

Chiến dịch

Kiểm tra những chiến dịch đang có

Survey

Tạo mẫu khảo sát (Survey Template)

Kiểm tra mẫu khảo sát có sẵn

Tạo Section template

Phonebook & contact

Kiểm tra phonebook hiện có

Kiểm tra contact hiện có

Tạo Phonebook

Cập nhập Phonebook

Tạo Contact

- Create single contact

Cập nhập contact dựa trên id

- Create multiple contact (endpoint: /rest-api/bulkcontact/)

Tạo chiến dịch thoại

Kiểm tra gateway hiện có

Tạo chiến dịch

Cập nhật chiến dịch thoại

Thay đổi trạng thái chiến dịch thoại

Xóa chiến dịch thoại

Appointment

Survey List

Kiểm tra danh sách các survey

DNC (Do Not Call)

Kiểm tra danh sách DNC

Kiểm tra DNC Contact

Thêm vào DNC list

Thêm vào DNC Contact

Report

Kiểm tra báo cáo

Subcribers

Xem thành viên chiến dịch

Calendar

Thiết lập lịch

Calendar User

Tạo lịch

Tạo sự kiện

Tạo Alarm

​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​