API Cập nhật kịch bản

API Cập nhật 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

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

Chi tiết API

Cập nhật kịch bản

PUT https://aicall.vbee.ai/api/v1/public-api/scenarios/:scenarioId

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

Path Parameters

Name	Type	Description
scenarioId*	String	Định danh của kịch bản

Headers

Name	Type	Description
Authorization	String	Bearer <ACCESS_TOKEN>

Request Body

Name	Type	Description
description*	String	Mô tả kịch bản tối đa 1000 ký tự
tags*	String array	Danh sách các nhãn kịch bản, tối đa 5 phần tử, mỗi phần tử tối đa 50 ký tự
personalizedFields	personalizedField Array	Mảng personalField. Danh sách các trường cá nhân hóa
ttsConfig	Object	ttsConfig cấu hình giọng đọc
callConfig	callConfig Object	Cấu hình cuộc gọi
name*	String	Tên kịch bản tối da 300 ký tự

200: OK

{
    "result": {
        "call_config": {
            "allow_duplicate_phone": false,
            "call_routing": "RANDOM",
            "max_concurrent": 2,
            "max_duration": 30,
            "pool_hotline_key": "",
            "re_call": {
                "delay": 10,
                "is_busy": true,
                "is_failed": true,
                "is_no_answer": true,
                "is_voice_mail": false,
                "times": 1
            }
        },
        "created_at": "2023-10-20T08:07:19.112Z",
        "id": "65323537b3895aaf7929d791",
        "name": "Scenario test ",
        "personalized_fields": [
            {
                "name": "Số điện thoại",
                "reading_type": "TEXT"
            }
        ],
        "status": "DRAFT",
        "tags": [],
        "tts_config": {
            "language": "vi-VN",
            "speed": 1,
            "voice_code": "hn_female_ngochuyen_full_48k-fhg"
        },
        "updated_at": "2023-10-20T08:07:19.112Z"
    },
    "status": 1
}

ttsConfig

Trường	Loại	Mô tả
voiceCode	String	Mã giọng đọc
speed	Number	Tốc độ đọc tối thiểu 0.5 tối đa 1.5 mặc định là 1
language	String	Ngôn ngữ. Mặc định 'vi-VN'

reCall

Trường	Loại	Mô tả
times	Number	Số lần gọi lại tối thiểu 0
delay	Number	Thời gian chờ gọi lại, tối thiểu 0
isBusy	Boolean	Có gọi lại khi máy bận không. Mặc định false
isNoAnswer	Boolean	Có gọi lại khi người nhận không nghe máy không. Mặc định false
isVoiceMail	Boolean	Có gọi lại khi vào thư thoại không. Mặc định không
isFailed	Boolean	Có gọi lại khi gọi thất bại không. Mặc định không

callConfig

Trường	Loại	Mô tả
maxDuration	Number	Thời lượng cuộc gọi tối đa.Tối thiểu 1
maxConcurrent	Number	Tối đa số cuộc gọi đồng thời. Tối thiểu 1
poolHotlineKey	String	Nếu có callConfig trường này là bắt buộc.
callRouting	String	Hình thức đảo đầu số. Giá trị hợp lệ [RANDOM, ROUND_ROBIN]
allowDuplicatePhone	Boolean	Cho phép số điện thoại trùng lặp hay không. Mặc định là false
reCall	Object recall	Cấu hình gọi lại

personalizedFields

Trường	Loại	Mô tả
name	String	Tên trường
readingType	String	Cách đọc của trường cá nhân hóa. Giá trị hợp lệ TEXT: văn bản SEQ2SEQ: đọc từng ký tự DATE: ngày tháng CURENCY: tiền tệ

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/scenarios`,
  headers: {
    Authorization: `Bearer ${ACCESS_TOKEN}`,
  },
  data: {
    "name": "Scenario Name",
    "description": "Scenario Description",
    "tags": ["tag1", "tag2"],
    "ttsConfig": {
      "voiceCode": "en-US",
      "speed": 1.5
    },
    "personalizedFields": [
      {
        "name": "Field 1",
        "readingType": "type1"
      },
      {
        "name": "Field 2",
        "readingType": "type2"
      }
    ],
    "callConfig": {
      "maxDuration": 300,
      "maxConcurrent": 10,
      "poolHotlineKey": "Thiem mv test pool",
      "reCall": {
        "times": 3,
        "delay": 10,
        "isBusy": true,
        "isNoAnswer": true,
        "isVoiceMail": true,
        "isFailed": true
      },
      "allowDuplicatePhone": true, 
      "callRouting": "RANDOM"
    }
});

cURL

curl --location 'https://aicall.vbee.ai/api/v1/public-api/scenario-actions' \
--header 'Authorization: Bearer ${ACCESS_TOKEN}' \
--header 'Content-Type: application/json' \
--data '{
  "name": "Scenario Name",
  "description": "Scenario Description",
  "tags": ["tag1", "tag2"],
  "ttsConfig": {
    "voiceCode": "en-US",
    "speed": 1.5
  },
  "personalizedFields": [
    {
      "name": "Field 1",
      "readingType": "type1"
    },
    {
      "name": "Field 2",
      "readingType": "type2"
    }
  ],
  "callConfig": {
    "maxDuration": 300,
    "maxConcurrent": 10,
    "poolHotlineKey": "Thiem mv test pool",
    "reCall": {
      "times": 3,
      "delay": 10,
      "isBusy": true,
      "isNoAnswer": true,
      "isVoiceMail": true,
      "isFailed": true
    },
    "allowDuplicatePhone": true, 
    "callRouting": "RANDOM"
  }
}
'