OmiCall API
  • Overview
  • OMICALL API
    • Tổng quan
    • Xác thực
    • Doanh nghiệp
    • Nhân viên
    • Khách hàng
      • v1
      • v2
    • Tổng đài
    • Lịch sử cuộc gọi
      • v1
      • v2
    • Gọi tự động
      • Gọi tự động sử dụng callBot
      • Gọi tự động thông thường - API V2
    • Webhooks
    • Click To Call
    • Ticket
      • v2
    • API tiêu chí kịch bản
    • Đa kênh
    • AI API
      • Text To Speech API
      • Speech To Text API
      • Gọi tự động sử dụng callBot
      • Phân tích cuộc gọi
  • WEBHOOKS
    • Tổng quan
    • Webhook
  • SDK Tích Hợp
    • Web Extension
      • Changelog
      • Pancake
      • Sapo
      • Haravan
      • Nhanh.vn
      • TPos.vn
      • KiotViet
      • Bitrix24
    • Web SDK
      • v3 Integration
      • v3 Changelog
      • v2 Integration
      • v2 Changelog
    • MOBILE SDK
      • Tổng Quan
      • Tại sao lại sử dụng OMICALL
      • Định nghĩa đầu số
      • Các SDK Hỗ Trợ
      • Tài khoản đăng nhập
      • IOS SDK
        • Cấu hình Push Notification
        • Cài đặt
        • Khởi tạo SDK
        • Xử lý các sự kiện
      • Android SDK
        • Cấu hình SDK
        • Cấu hình Push Notification
        • Khởi tạo SDK
        • Lắng nghe các sự kiện
      • Flutter SDK
      • React-Native SDK
    • Deep Links App to App
  • PARTNER
    • Tổng quan
    • Kho đầu số
    • Gói dịch vụ
    • Lịch sử thanh toán
    • Quản lý doanh nghiệp
    • Thông tin đối tác
Powered by GitBook
On this page
  • Gọi tự động tới một số điện thoại khách hàng
  • Lấy danh sách kịch bản bot

Was this helpful?

  1. OMICALL API
  2. Gọi tự động

Gọi tự động sử dụng callBot

API gọi tự động

Gọi tự động tới một số điện thoại khách hàng

POST [URL]/api/call_bot/execute_by_phone

Tạo một phiên callBot với tham số đầu vào là một kịch bản callbot và 1 danh sách các thông tin liên hệ

Query Parameters

Name
Type
Description

cid*

String

Số hotline hay số SIP sẽ thực hiện chạy phiên.

Nếu gọi nội mạng, truyền giá trị rỗng.

Headers

Name
Type
Description

Content-type

string

application/json

Authorization

string

Access Token Bearer token

x-api-key*

String

API key được cung cấp

Request Body

Name
Type
Description

speed

number

Tốc độ đọc.Từ chậm : -3. Đến nhanh : 3.

Mặc định là 0

voice

string

Giọng đọc, có thể một trong các giá trị sau + "northern_female_ngocanh" : Ngọc Anh

+ "southern_female_honganh" : Hồng Anh

+ "southern_male_tienhuy" : Tiến HuyQ

cid

string

Đầu số dùng để gọi tự động. Nếu không truyền, mặc định ưu tiên gọi nội mạng

name

string

Tên của phiên gọi tự động

num_retry

Integer

Số lần gọi lại khi không nghe máy. Mặc định là 0

num_per_call

Integer

Số cuộc gọi mỗi lần. Mặc định là 15

distance_per_call

Integer

Khoảng cách thời gian , giữa các lần gọi. Mặc định là 30s

distance_retry

Integer

Khoảng cách giữa các lần gọi lại . Mặc định là 0

bot_script_id

String

Id kịch bản, được lấy ở danh sách trong hệ thống

send_time

Number

Thời gian thực hiện phiên (milisecond)

Nếu không truyền giá trị, sẽ thực hiện gọi ngay

contact_info*

Array

Danh sách contact cần gọi

Giá trị:

  • phone : Số điện thoại KH

  • email: Email khách hàng nếu có

  • ext_contact_code : Mã KH bên thứ 03

  • mapping_variables : Hỗ trợ cho phép truyền biến động từ đối tác. Danh sách và chi tiết biến động cần truyền trong (API lấy danh sách KB Callbot)

ext_session_id

String

Mã định danh phiên bên ngoài CRM (tránh trường hợp lên trùng phiên do double summit)

Nếu có giá trị field này, mới kiểm tra trùng

auto_pause

Boolean (true, false)

Cho phép phiên tự động dừng khi không có nhân viên hiệu lực không. Cấu hình này chỉ áp dụng cho kịch bản gọi vào nhóm nội bộ

{
    "instance_id": "stg",
    "payload": {
        "bot_script_id": "653b155db0f794**********",
        "autocall_id": "6552de1891be25**********"
    },
    "instance_version": "1.2.164",
    "key_enabled": false,
    "status_code": 9999
}

Hướng dẫn liên kết biến động trong CallBot AI

Lấy danh sách kịch bản bot

GET [URL]/api/call_bot/script/list

Lấy danh sách kịch bản callBot do khách hàng thiết lập

{
	"instance_id": "stg",
	"payload": [
		{
			"id": "64915bc76a690c0edad14723",
			"name": "Thông báo điểm thi",
			"variables": [
				{
					"field_name": "tên thí sinh",
					"field_code": "tên thí sinh",
					"field_value": "",
					"field_type": "",
					"type": "",
					"is_dynamic_attribute": true
				},
				{
					"field_name": "Toán",
					"field_code": "uB131frQEU",
					"field_value": "",
					"field_type": "single_text",
					"type": "CONTACT",
					"is_dynamic_attribute": true
				}
			]
		},
		{
			"id": "64a922f61900954f5419d503",
			"name": "Cảnh báo từ khóa tiêu cực",
			"variables": [
				{
					"field_name": "",
					"field_code": "nhanvien",
					"field_value": "",
					"field_type": "",
					"type": "",
					"is_dynamic_attribute": true
				},
				{
					"field_name": "",
					"field_code": "tenkhachhang",
					"field_value": "",
					"field_type": "",
					"type": "",
					"is_dynamic_attribute": true
				},
				{
					"field_name": "",
					"field_code": "sodienthoai",
					"field_value": "",
					"field_type": "",
					"type": "",
					"is_dynamic_attribute": true
				},
				{
					"field_name": "",
					"field_code": "thoigiangoi",
					"field_value": "",
					"field_type": "",
					"type": "",
					"is_dynamic_attribute": true
				},
				{
					"field_name": "",
					"field_code": "diem",
					"field_value": "",
					"field_type": "",
					"type": "",
					"is_dynamic_attribute": true
				}
			]
		}
	],
	"instance_version": "1.2.164",
	"key_enabled": false,
	"status_code": 9999
}

PreviousGọi tự độngNextGọi tự động thông thường - API V2

Last updated 6 months ago

Was this helpful?

{
            "phone":"0395187***",
            "email":"",
            "ext_contact_code":"",
            "mapping_variables":{
                "gender1":"Anh",
                "full_name":"Trần Văn Tiến",
                "address":"Phan Huy Ích",
                "mail":"tientv@***.com",
                "birthday":"11/10/19***"
            }
        }