API Xóa kịch bản

Cho phép khách hàng xóa 1 kịch bản chưa có cuộc gọi nào được thực hiệ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. Đã tạo kịch bản (xem cách tạo)

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

Lưu ý khi xóa hành động trong kịch bản

Khi xóa kịch bản sẽ xóa tất cả thông tin liên quan đến chiến dịch và các action được tạo bởi kịch bản

Chi tiết API

Xóa 1 kịch bản

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

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

Path Parameters

Name	Type	Description
scenario_id*	String	Mã của kịch bản gọi ra

Headers

Name	Type	Description
Authorization*	String	Bearer <ACCESS_TOKEN>

200: OK Thành công

{
  "status": 1
}

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	Scenarios not found	Không tìm thấy kịch bản
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: 'DELETE',
  url: `https://aicall.vbee.ai/api/v1/public-api/scenarios/${SCENARIO_ID}`,
  headers: {
    Authorization: `Bearer ${ACCESS_TOKEN}`,
  },
});

Python

import requests

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

requests.delete(
    url=f'https://aicall.vbee.ai/api/v1/public-api/scenarios/{SCENARIO_ID}',
    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/" + SCENARIO_ID)
                .header("Authorization", "Bearer " + ACCESS_TOKEN)
                .delete()
                .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/' . $SCENARIO_ID);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
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);