API Tạo hành động

API Tạo kịch bản

Tiền điều kiện:

1. Đã tạo Ứng dụng trên hệ thống Vbee AICall Cloud (xem cách tạo)

2. Đã có kịch bản (xem cách tạo)

3. Đã tạo ACCESS_TOKEN (xem cách tạo)

Chi tiết API

Tạo hành động trong kịch bản

POST https://aicall.vbee.ai/api/v1/public-api/scenario-actions

(*) Trường bắt buộc

Headers

Name	Type	Description
Authorization	String	Bearer <ACCESS_TOKEN>

Request Body

Name	Type	Description
scenarioId*	String	Id của kịch bản
type*	String	[INTERACTIVE_MENU, CALL_FORWARD]
contentText	String	Bắt buộc nếu contentType là TEXT. Nội dung lời thoại của phím bấm
contentType	String	Bắt buộc nếu type là INTERACTIVE_MENU. Giá trị hợp lệ [TEXT]
replayContentType	String	Loại lời thoại khi phản hồi không hợp lệ [TEXT]
forwardType	String	Bắt buộc nếu type là INTERACTIVE_MENU. Giá trị hợp lệ - PHONE_NUMBER: gọi đến dầu số cá nhân
responseSetting	Object	Object responseSetting
replayContentText	String	Bắt buộc nếu replayContentType là TEXT. Nội dung lời thoại khi phản hồi không hợp lệ.
callCenterAddress	String	Địa chỉ tổng đài
phoneNumbers	String array	Bắt buộc nếu forwardType là PHONE_NUMBER. Một mảng các số điện thoại. Yêu cầu ít nhất một số điện thoại.
isShufflePhoneNumbers	String	Chọn lọc số điện thoại ngẫu nhiên. Mặc định là false.

200: OK

{
    "result": {
        "action_inputs": [],
        "action_outputs": [],
        "content_text": "Phim 5",
        "content_type": "TEXT",
        "id": "653237f46782057b8e461228",
        "label": "Handle node 5",
        "response_setting": {
            "response_type": "KEYPAD"
        },
        "responses": [],
        "scenario_id": "6532317c678205c274460d49",
        "type": "INTERACTIVE_MENU",
    },
    "status": 1
}

responseSetting

Trường	Loại	Mô tả
responseType	String	Loại phản hồi tương tác. Dữ liệu hợp lệ [KEYPAD: phản hồi qua phím bấm]
maxReplay	Number	Số lần lặp lại khi phản hồi không hợp lệ
timeout	Number	Thời gian chờ phản hồi)

Chú ý

Hành động đầu tiên trong kịch bản không có cài đặt phản hồi, bao gồm thời gian chờ và số lần phát lại tối đa. Điều này có nghĩa là sau khi phát lời thoại, hành động này sẽ tự động dừng kịch bản và kết thúc. Để tránh điều này, khi cập nhật kịch bản, bạn cần thêm giá trị cho hai trường này.

responseSetting: { responseType: "KEYPAD", timeout: 5 },

Nếu bạn có kích hoạt webhook, xem định dạng dữ liệu trả về ở mục Webhook API

Nội dung lỗi trả về có thuộc tính status luôn là 0. Ví dụ:

{
  "status": 0,
  "code": 401,
  "message": "Unauthorized"
}

Danh sách mã lỗi:

Code	Message	Mô tả
401	Unauthorized	ACCESS_TOKEN không hợp lệ
1201	Application is not found	Không tìm thấy ứng dụng (kiểm tra lại thông tin API_KEY)
3001	Scenario s not found	Không tìm thấy kịch bản
3006	Status of scenario must be DRAFT to submit	Chỉ có thể duyệt kịch bản ở trạng thái nháp
9999	Uknown error	Lỗi phát sinh trên hệ thống

Code mẫu

JavaScript

const axios = require('axios');

const ACCESS_TOKEN = '<ACCESS_TOKEN>';
const SCENARIO_ID = '<SCENARIO_ID>';

axios({
  method: 'POST',
  url: `https://aicall.vbee.ai/api/v1/public-api/scenario-actions`,
  headers: {
    Authorization: `Bearer ${ACCESS_TOKEN}`,
  },
  data: {
    scenarioId: '6530d94a1d00aacd79ce6e99',
    type: 'INTERACTIVE_MENU',
    label: `Handle node 1`,
    contentType: 'TEXT',
    contentText: `Phím 1 được nhấn`,
    responseSetting: {
      responseType: 'KEYPAD',
    },
  }
});

cURL

curl --location 'https://aicall.vbee.ai/api/v1/public-api/scenario-actions' \
--header 'Authorization: Bearer ${ACCESS_TOKEN}' \
--header 'Content-Type: application/json' \
--data '{
  "scenarioId": "652ff54961561b0c8b34e020",
  "type": "INTERACTIVE_MENU",
  "label": "Handle node 5",
  "contentType": "TEXT",
  "contentText": "Phim 5",
  "responseSetting": {
    "responseType": "KEYPAD"
  }
}
'