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
  • Lấy token chứng thực ( Get Authentication Token)
  • Click to call​
  • Lấy danh sách cuộc gọi​
  • Lấy file ghi âm​
  1. Hướng dẫn tích hợp API (Team technical) (API integration guide (technical team))
  2. AntRing

Danh sách API (API List)

PreviousSử dụng API (Use API)NextMã lỗi (Error code)

Last updated 2 months ago

Lấy token chứng thực ( Get Authentication Token)

Sử dụng cho việc nhận websocket về các signal của cuộc gọi

URL: /oapi/v1/voice/auth_token

METHOD: POST

Content Type: application/json‌

Headers:

Thuộc tính
Kiểu dữ liệu
Giá trị

x-auth-app-id

String

Định danh 3rd party

x-auth-app-hash

String

sha256(appId + appSecret)

Kết quả:

Status
Kết quả

200

{ value: <auth_token>, expire: <expire time> }

Click to call

URL: /oapi/v1/call/click-to-call/:number

METHOD: POST

Content Type: application/json‌

Headers:

Thuộc tính
Kiểu dữ liệu
Giá trị

x-auth-app-id

String

Định danh 3rd party

x-auth-app-hash

String

sha256(appId + appSecret)

Tham số:

Thuộc tính
Kiểu dữ liệu
Giá trị

sipUser

String

Device name thực hiện việc click to call

sipPassword

String

Mật khẩu

Kết quả:‌

Status
Kết quả

200

Device online, click to call thành công

400

Device offline, click to call thất bại

note

Để nhận được cuộc gọi, device sip cần register lên hệ thống, mã lỗi 400 là do device chưa register đến hệ thống

URL: /oapi/v1/call/histories‌

METHOD: GET‌

Content Type: application/json‌

Tham số:

Thuộc tính
Kiểu dữ liệu
Giá trị

appId

String

Định danh 3rd party

created_from

String

Ngày bắt đầu

created_to

String

Ngày kết thúc

limit

Number

Giới hạn số record trên 1 trang. Mặc định 20

page

Number

Trang hiện tại, mặc định 1

hash

String

sha256(appId+created_from+created_to+limit+page+appSecret)

Trong đó:‌

  • Thời gian filter tối đa là 31 ngày

  • Limit mặc định là 20 record, tối đa 100

  • Page mặc định là 1

Kết quả:

Thuộc tính
Ví dụ
Mô tả

caller

Mô tả người gọi. Đối với type=user, có thêm trường username để định danh user.

callee

Mô tả người nhận. Đối với type=user, có thêm trường username để định danh user.

class

trunking

one_one: gọi nội bộ. trunking: gọi ra hoặc gọi vào hệ thống

did_number

02873019555

Số DID của công ty. Null: nếu gọi nội bộ hoặc gọi ra

direction

from_ab

from_ab: gọi ra. to_ab: gọi vào

status_detail

SUCCESS

IVR: Cuộc gọi vào / ra đến hệ thống đầu cuối nhưng người nhận chưa bắt máy. SUCCESS: Cuộc gọi thành công. CANCELLED: Thực hiện cuộc gọi ra và gác máy trước khi người nhận nhận cuộc gọi. BUSY: Thực hiện cuộc gọi ra nhưng đầu nhận bận máy. UNSUCCESS: Các lỗi khác

duration_seconds

50

Thời gian cuộc gọi ( tính bằng giây)

unix_timestamp

1519639917

Thời điểm xảy ra cuộc gọi. Tính theo unix timestamp

billing_seconds

43

Thời gian đàm thoại của cuộc gọi ( tính bằng giây)

recording

call_recording_dl5m5j5hfh4n8njj1oor.mp3

File ghi âm. Trường hợp không có ghi âm thì trường này rỗng.

Giới hạn:‌ Chỉ cho phép lấy lịch sử cuộc gọi tối đa 31 ngày‌

URL: /oapi/v1/call/play_recording‌

METHOD: GET‌

Content Type: application/json‌

Tham số:

Tham số
Kiểu dữ liệu
Mô tả

appId

String

Định danh 3rd party

media

String

Tên file recording

hash

String

sha256(appId +media+ appSecret)

Kết quả:‌

Đường dẫn URL của file media

Thuộc tính
Ví dụ
Mô tả

media

Đường dẫn file ghi âm

(

Used for receiving websocket signals for call events.Comment

  • URL: /oapi/v1/voice/auth_tokenComment

  • METHOD: POSTComment

  • Content Type: application/jsonComment

CommentHeaders:Comment

Property

Data Type

Value

x-auth-app-id

String

3rd party identifier

x-auth-app-hash

String

sha256(appId + appSecret)

CommentResponse:Comment

Status

Result

200

{ value: <auth_token>, expire: <expire time> }

Comment


Comment2. Click to CallComment

  • URL: /oapi/v1/call/click-to-call/:numberComment

  • METHOD: POSTComment

  • Content Type: application/jsonComment

CommentHeaders:Comment

Property

Data Type

Value

x-auth-app-id

String

3rd party identifier

x-auth-app-hash

String

sha256(appId + appSecret)

CommentParameters:Comment

Property

Data Type

Value

sipUser

String

Device name for click to call

sipPassword

String

Password

CommentResponse:Comment

Status

Result

200

Device online, click to call successful

400

Device offline, click to call failed

CommentNote: To receive the call, the SIP device must be registered on the system. Error 400 occurs when the device is not registered.Comment


Comment3. Get Call HistoryComment

  • URL: /oapi/v1/call/historiesComment

  • METHOD: GETComment

  • Content Type: application/jsonComment

CommentParameters:Comment

Property

Data Type

Value

appId

String

3rd party identifier

created_from

String

Start date

created_to

String

End date

limit

Number

Limit of records per page, default 20

page

Number

Current page, default 1

hash

String

sha256(appId + created_from + created_to + limit + page + appSecret)

CommentNotes:Comment

  • Maximum time filter is 31 days.Comment

  • Default limit is 20 records, maximum 100.Comment

  • Default page is 1.Comment

CommentResponse:Comment

Property

Example

Description

caller

{number: "01693608879", type: "realnumber"}

Caller details, with username if type=user

callee

{number: "thutranhtkbee", type: "user", username: "thutran"}

Callee details, with username if type=user

class

trunking

Call type: one_one for internal, trunking for inbound/outbound calls

did_number

02873019555

DID number for the company. Null if internal or outbound

direction

from_ab

from_ab for outbound calls, to_ab for inbound

status_detail

SUCCESS

Call status: IVR (system call not answered), SUCCESS, CANCELLED, BUSY, UNSUCCESS

duration_seconds

50

Duration of the call in seconds

unix_timestamp

1519639917

Call timestamp in Unix format

billing_seconds

43

Talk time for the call in seconds

recording

call_recording_dl5m5j5hfh4n8njj1oor.mp3

File path for the recording, empty if no recording

CommentLimit: The call history can only be retrieved for a maximum of 31 days.Comment


Comment4. Get Call RecordingComment

  • URL: /oapi/v1/call/play_recordingComment

  • METHOD: GETComment

  • Content Type: application/jsonComment

CommentParameters:Comment

Property

Data Type

Description

appId

String

3rd party identifier

media

String

Recording file name

hash

String

sha256(appId + media + appSecret)

CommentResponse:Comment

Property

Example

Description

media

https://abs1.antbuddy.com/nkrecord/call_recording_F5879958-1A1211E8-A55AA457-72574952%40172.16.0.204.mp3?AWSAccessKeyId=E7IPYE4LN28Y4I6T4400&Expires=1519640615&Signature=wXNENYxr0OJR8vA26kvOOwsttzU%3D

URL link to the recording file

)

Lấy danh sách cuộc gọi

Lấy file ghi âm

​

{
  number:"01693608879",
  type:"realnumber"
}
{
  number:"thutranhtkbee",
  type:"user",
  username:"thutran"
}
​
​
​
https://abs1.antbuddy.com/nkrecord/call_recording_F5879958-1A1211E8-A55AA457-72574952%40172.16.0.204.mp3?AWSAccessKeyId=E7IPYE4LN28Y4I6T4400&Expires=1519640615&Signature=wXNENYxr0OJR8vA26kvOOwsttzU%3D​