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

Cho phép khách hàng lấy ra danh sách các kịch bản đã được tạo

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. Đã tạo kịch bản (xem cách tạo)

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

Chi tiết API

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

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

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

Query Parameters

Name	Type	Description
status	String	Trạng thái của kịch bản, mặc định sẽ lấy tất cả các kịch bản. Giá trị hợp lệ: DRAFT: Đang biên tập ACTIVE: Đã được duyệt REVIEWING: Đang chờ duyệt REJECT: Không được duyệt
fields	String	Danh sách các trường muốn trả về Ví dụ: Nếu muốn trả về chỉ tên kịch bản và mô tả của kịch bản thì truyền vào name,description
limit	String	Số phần tử muốn lấy tối đa của mỗi truy vấn, mặc định là 10 phần tử, tối đa 50 phần tử
offset	String	Vị trí bắt đầu muốn lấy kịch bản. Mặc định là 0
	String

Headers

Name	Type	Description
Authorization*	String	Bearer <ACCESS_TOKEN>

200: OK Thành công

{
   "result": {
       "scenarios": Array,
       "total_count": int
   },
   "status": int
}

Trong đó: 
- result là kết quả trả về
    - scenarios là một mảng danh sách các kịch bản trả về
    - total_count là tổng số phần tử hợp lệ với yêu cầu tìm kiếm

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ệ
400	Validation Failed	Các trường đầu vào 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)
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: 'GET',
  url: `https://aicall.vbee.ai/api/v1/public-api/scenarios`,
  headers: {
    Authorization: `Bearer ${ACCESS_TOKEN}`,
  },
});

Python

import requests

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

requests.get(
    url=f'https://aicall.vbee.ai/api/v1/public-api/scenarios',
    headers={
        "Authorization": f'Bearer {ACCESS_TOKEN}'
    }
)

Java

package org.example;

import okhttp3.*;
import java.io.IOException;

public class Main {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        String ACCESS_TOKEN = "<ACCESS_TOKEN>";
        String SCENARIO_ID = "<SCENARIO_ID>";
        
        Request request = new Request.Builder()
                .url("https://aicall.vbee.ai/api/v1/public-api/scenarios/")
                .header("Authorization", "Bearer " + ACCESS_TOKEN)
                .get()
                .build();

        try {
            Response response = client.newCall(request).execute();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

PHP

<?php
$ACCESS_TOKEN = '<ACCESS_TOKEN>';
$SCENARIO_ID = '<SCENARIO_ID>';

$ch = curl_init('https://aicall.vbee.ai/api/v1/public-api/scenarios');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
   'Authorization: Bearer ' . $ACCESS_TOKEN,
   'Content-Type: application/json'
));

$response = curl_exec($ch);
curl_close($ch);