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":"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***" } } 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ộ

200 Thông tin phiên gọi tự động

{
    "instance_id": "stg",
    "payload": {
        "bot_script_id": "653b155db0f794**********",
        "autocall_id": "6552de1891be25**********",
        "errors" : [
		    	{
		  	  	"phone" : "09xxxxxxxx",
		  	  	"error_code" : "number_dnc",
		    		"message" : "Number DNC"
		    	}
	    	]
    },
    "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

Tạo phiên gọi tự động v2

POST [URL]/api/v2/call-bot/request

Tạo một phiên gọi tự động bằng callBot với danh sách khách hàng, kịch bản gọi và cấu hình callback kết quả (không bắt buộc).

Headers

Name	Type	Required	Description
Authorization	String	Yes	Access token: Bearer 'token'
Content-Type	String	Yes	application/json

Request Body

Field	Type	Required	Description
contacts	Array	Yes	Danh sách khách hàng cần gọi
contacts[].phoneNumber	String	Yes	Số điện thoại khách hàng
contacts[].extendVariableMap	Object	No	Biến động để map vào kịch bản callBot
contacts[].refId	String	No	Reference Id trả về trong callback (nếu có cấu hình callback)
sipNumbers	Array	Yes	Danh sách số SIP/đầu số thực hiện gọi
scriptId	String	Yes	ID kịch bản callBot
sessionName	String	No	Tên phiên gọi
voice	String	No	Giọng đọc, ví dụ: northern_female_ngocanh
timeSlots	Array	No	Danh sách khung giờ gọi. Mỗi phần tử có dạng {\"from\":\"HH:mm\",\"to\":\"HH:mm\"}
numberRetryCall	Number	No	Số lần gọi lại khi chưa kết nối thành công
retryCallAfterSeconds	Number	No	Số giây chờ trước khi gọi lại
callbackResultConfig	Object	No	Cấu hình callback nhận kết quả
callbackResultConfig.url	String	No	URL webhook nhận callback kết quả gọi

Example cURL

curl --location '[URL]/api/v2/call-bot/request' \
--header 'x-api-key: <your_api_key>' \
--header 'Content-Type: application/json' \
--data '{
    "contacts" : [
        {
            "phoneNumber" : "0123456789",
            "extendVariableMap" : {
                "var1" : "test"
            }
        }
    ],
    "sipNumbers" : ["0238923xxx"],
    "scriptId" : "6915460746197d6920ca1xxx",
    "sessionName" : "Test session",
    "voice" : "northern_female_ngocanh",
    "timeSlots" : [],
    "numberRetryCall" : 1,
    "retryCallAfterSeconds" : 120,
    "callbackResultConfig" : {
        "url" : "hook_url"
    }
}'

Response

200: OK

{
    "instance_id": "stg",
    "payload": true,
    "instance_version": "1.2.164",
    "key_enabled": false,
    "status_code": 9999
}

Webhook response (nếu có config webhook)

Init session

 {
    "type": "INIT_SESSION",
    "data": {
      "tenantId"     : "",
      "sessionId"    : "",
      "sessionName"  : "",
      "sessionTimeMs": 1776798232000,
      "details"      : [
        {
          "phoneNumber": "",
          "recordId"   : "",
          "refId"      : "",
          "status"     : "",
          "errorCode"  : ""
        }
      ]
    }
  }

Init call

{
    "type": "INIT_CALL",
    "data": {
      "tenantId"     : "",
      "sessionId"    : "",
      "sessionName"  : "",
      "sessionTimeMs": 1776798232000,
      "details"      : [
        {
          "isSuccess"   : true,
          "errorCode"   : "",
          "errorMessage": "",
          "recordId"    : "",
          "refId"       : "",
          "sipNumber"   : "",
          "phoneNumber" : ""
        }
      ]
    }
  }

Complete call

{
    "type": "COMPLETE_CALL",
    "data": {
      "tenantId"     : "",
      "sessionId"    : "",
      "sessionName"  : "",
      "sessionTimeMs": 1776798232000,
      "details"      : [
        {
          "recordId"   : "",
          "refId"      : "",
          "sipNumber"  : "",
          "phoneNumber": "",
          "status"     : ""
        }
      ]
    }
  }

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

200: OK

{
	"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
}

Đếm số lượng cuộc gọi của phiên

POST [URL]/api/call_bot/call/count

Header

Name	Type	Required	Description
Authorization	String	Yes	Access token: Bearer 'token'
Content-Type	String	Yes	application/json

Request Body

Field	Type	Required	Description
autocall_id	String	Yes	Id của phiên autocall
phones	Arrays	No	Danh sách số điện thoại cần đếm. Nếu để trống sẽ đếm toàn bộ phiên

Example cURL

curl --location '[URL]/api/call_bot/call/count' \
--header 'x-api-key: <your_api_key>' \
--header 'Content-Type: application/json' \
--data '{
    "autocall_id": "6912a712f9c97b58c60b9f63",
    "phones": [
        "070599****"
    ]
}'

200: OK

{
    "instance_id": "stg",
    "payload": 0,
    "instance_version": "1.2.164",
    "key_enabled": false,
    "status_code": 9999
}

Lấy chi tiết kịch bản callbot

GET [URL]/api/call_bot/get_by_id/:id

Header

Name	Type	Required	Description
Authorization	String	Yes	Access token: Bearer 'token'
Content-Type	String	Yes	application/json

Example cURL

curl --location '[URL]/api/call_bot/get_by_id/:id' \
--header 'content-type: application/json' \
--header 'x-api-key: <your_api_key>'

200: OK

{
  "instance_id": "stg",
  "instance_version": "1.2.164",
  "key_enabled": false,
  "payload": {
    "id": "69e82c04d0******",
    "uuid": "0739227b-677f-441f*****",
    "tenant_id": "634cb99eb255*****",
    "name": "123123",
    "variables": [],
    "connections": [
      {
        "sourceHandle": "1",
        "animated": false,
        "style": {
          "strokeWidth": 3,
          "stroke": "#00B1FF"
        },
        "id": "reactflow__edge-wfyesGZDhO1-xkEm6QmM6M1",
        "source": "wfyesGZDhO",
        "type": "custom",
        "targetHandle": "1",
        "target": "xkEm6QmM6M"
      }
    ],
    "nodes": [
      {
        "id": "wfyesGZDhO",
        "node_type": "BEGIN",
        "next_nodes": [
          "xkEm6QmM6M"
        ],
        "is_collapse": false
      },
      {
        "id": "xkEm6QmM6M",
        "node_type": "STAFF",
        "template_content": "",
        "return_template_content": "",
        "wrong_response_content": "",
        "customer_response_delay": 10000,
        "is_collapse": false,
        "audio_file": {
          "name": "ghi âm.mp3",
          "src": "634cb99eb255dc***/callbot_recording_file/2026/04/9f921f48-8700-4209-808e-0496d45279db.mp3",
          "duration": "21.6",
          "pbx_source": "/mnt/data/freeswitch/recordings/testtruong1710/callbot/2026/04/af684879-3e4e-4f4b-995e-fdfebbc6a6ca.mp3"
        }
      }
    ],
    "is_draft": true,
    "created_date": 1776823300555,
    "last_updated_date": 1776823300894,
    "last_publish_time": 1776823300555,
    "created_by": {
      "id": "634cb99eb25***",
      "name": "Tên",
      "contact_id": "634cb99eb25",
      "avatar_url": null,
      "ref_type": null,
      "gender": null,
      "email": null
    },
   
    "last_updated_by": {
      "id": "634cb99eb25***",
      "name": "Tên",
      "contact_id": "634cb99eb25",
      "avatar_url": null,
      "ref_type": null,
      "gender": null,
      "email": null
    },
    "is_deleted": false,
    "collect_authentication_data": "NONE",
    "system_intent_ids": [],
    "system_entity_type_ids": [],
    "version": 1,
    "is_newest_version": false,
    "is_publish": true,
    "custom_variables": [],
    "classifies": [],
    "variables_with_order": [],
    "speed": 1,
    "voice": "northern_female_ngocanh",
    "type": "NORMAL",
    "is_interrupt": false,
    "parse_datetime": false
  },
  "status_code": 9999
}