# Gọi tự động ## Gọi tự động tới một số điện thoại khách hàng `POST` `[URL]/api/auto_call/execute_by_phone` Tạo phiên gọi tự động dựa trên cấu hình & thực thi #### Headers | Name | Type | Description | | ------------- | ------ | ------------------------- | | Content-type | string | application/json | | Authorization | string | Access Token Bearer token | #### 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
banmai : Giọng nữ miền Bắc
leminh : Giọng nam miền Bắc
lannhi : Giọng nữ miền Nam

| | 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 | | template\_dialplans | array |

Cấu trúc phiên gọi tự động theo loại. (tham khảo ví dụ)
1. Phiên gọi tự động với file ghi âm

2. Phiên gọi tự động với Text To Speech

3. Phiên gọi tự động với file ghi âm và Text To Speech.

4. Phiên gọi tự động với kịch bản bấm phím

| | variables | string |

Mảng giá trị cho Text To Speech
Ví dụ
\[
"Đơn hàng của bạn là ",
"CKHDKD00203",
"Số tiền",
"900000",
"Đã được bàn giao cho đối tác vận chuyển"
]

| | phone\_number\_list\* | Array | Danh sách số điện thoại cần gọi | | 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 | {% tabs %} {% tab title="200 Thông tin phiên gọi tự động" %} ``` { "status_code": 9999, "payload": { "autocall_id": "91d3e842-9da2-43ec-8bb1-979c17e817ad", "name": "Chiến dịch giới thiệu sản phẩm mới" } } ``` {% endtab %} {% endtabs %} ## Gọi tự động tới 1 máy nhánh (extension) của tổng đài `POST` `[URL]/api/auto_call/execute_by_extension` #### Request Body | Name | Type | Description | | ----------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | template\_dialplans\* | Array |

Cấu trúc của cuộc gọi , tham khảo ví dụ bên dưới
1. Phiên gọi tự động với file ghi âm

2. Phiên gọi tự động với Text To Speech

3. Phiên gọi tự động với file ghi âm và Text To Speech. Thực thi theo thứ tự

4. Phiên gọi tự động với kịch bản bấm phím

| | variables\* | Array | Mãng giá trị chuỗi, chứa nội dung văn bản cần đọc , nếu kịch bản có chứa Text To Speech | | extensions\* | Array | Danh sách các số máy lẻ nhận cuộc gọi | | cid\* | String | Số hotline gọi ra định danh cho cuộc gọi | | brand\_name | String | Tên thương hiệu cần hiển thị, thay vì đầu số hotline | {% tabs %} {% tab title="200: OK " %} ```json { "instance_id": "stg", "payload": { "autocall_uuids": [ "f5d39f30-fef7-49df-9ef6-697bf5353983" ], "autocall_id": "64b8117691447377aecac985" }, "instance_version": "1.2.164", "key_enabled": false, "status_code": 9999 } ``` {% endtab %} {% endtabs %} **Ví dụ** :Tham số một phiên gọi tự động với **File ghi âm** ``` { "name":"Chiến dịch giới thiệu sản phẩm mới", "speed" : 0 "template_dialplans":[ { "target_type":"Recording", "target":"5ed0c6dffb7b390007e5211" } ], "variables":[] } ``` **Ví dụ** : Tham số một phiên gọi tự động với **Text To Speech** ``` { "name":"Thông báo đơn hàng", "template_dialplans":[ {"target_type":"Text_variable"}, {"target_type":"Text_variable"}, {"target_type":"Text_variable"}, {"target_type":"Text_variable"} ], "variables":[ "Đơn hàng của bạn là", "HHKKK", "Tổng giá trị", "90000" ] } ``` **Ví dụ** :Tham số một phiên gọi tự động **File ghi âm và Text To Speech** ``` { "name":"Tên phiên gọi tự động", "template_dialplans":[ {"target_type":"Text_variable"}, {"target_type":"Text_variable"}, {"target_type":"Text_variable"}, {"target_type":"Text_variable"}, { "target_type":"Recording", "target":"5e9eac95e44159000710f0xxx" }], "variables" : [ "Đơn hàng của bạn là", "HHKKK", "Tổng giá trị", "90000" ] } ``` Ví dụ về phiên gọi tự động : **Kịch bản bấm phím** ``` { "name":"Tên phiên gọi tự động", "template_dialplans":[ { "target_type":"Ivr_menu", // Id phiên bấm phím, // API : Tổng đài >> Danh sách kịch bản bấm phím "target":"5e9eac95e44159000710f0xxx" }], "variables" : [ ] } ``` | Mã lỗi | Mô tả | | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | limit\_service | Giới hạn gói dịch vụ. Gói trải nghiệm không cho phép thực thi Auto Call | | limit\_word |

Vượt quá giới hạn từ trong 1 phiên hoặc tổng số từ trong ngày

(300 ký tự / phiên và 3.000 ký tự / ngày )

| | limit\_word\_session | Vượt quá số lượng ký tự text to speech. Chỉ hỗ trợ 300 ký tự / 1 phiên | | balance\_is\_not\_enough | Số dư không đủ để thực hiện |