API Lấy thông tin kịch bản

Lấy thông tin của kịch bản bằng cách gọi API

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 thông tin kịch bản

GET 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

{
  "result": {
      "call_config": {
            "allow_duplicate_phone": false,
            "call_routing": "RANDOM",
            "max_concurrent": 2,
            "max_duration": 30,
            "pool_hotline_key": "POOL_SYSTEM",
            "re_call": {
                "delay": 10,
                "is_busy": true,
                "is_failed": true,
                "is_no_answer": true,
                "is_voice_mail": false,
                "times": 1
            }
        },
        "created_at": "2023-10-10T10:23:12.652Z",
        "description": "Mô tả kịch bản mẫu",
        "id": "65252610c41c5b7fbb84e6d3",
        "image_url": "",
        "name": "Kịch bản mẫu",
        "personalized_fields": [
            {
                "name": "Số điện thoại",
                "reading_type": "TEXT"
            },
            {
                "name": "Danh xưng",
                "reading_type": "TEXT"
            },
            {
                "name": "Họ và tên",
                "reading_type": "TEXT"
            }
        ],
        "status": "DRAFT",
        "tags": [],
        "tts_config": {
            "speed": 1,
            "voice_code": "hn_female_ngochuyen_full_48k-fhg"
        },
        "updated_at": "2023-10-10T10:24:01.707Z"
    },
  "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)
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/${SCENARIO_ID}`,
  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/{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)
                .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/' . $SCENARIO_ID);
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);