API tạm dừng gọi ra theo kịch bản

API tạm dừng gọi ra theo 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 gọi ra (xem cách tạo)

3. Kịch bản đang được sử dụng để gọi ra (có cuộc gọi đang thực hiện)

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

Trường hợp sử dụng

Theo nghiệp vụ của Vbee các kịch bản đang được sử dụng để gọi ra sẽ không thể chỉnh sửa. Vì vậy trong trường hợp bạn muốn chỉnh sửa khi đang thực hiện cuộc gọi do các vấn đề sai nội dung hoặc sai cấu hình, bạn sẽ cần sử dụng api này để tạm dừng gọi ra rồi mới có thể thực hiện sửa đổi.

Chi tiết API

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

(*) 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>

Request Body

Name	Type	Description
contacts*	Array	Danh sách liên hệ (xem định dạng Liên hệ)

200: OK Thành công

{
  "status": 1
}

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"
}

Code mẫu

NodeJS

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/${SCENARIO_ID}/stop`,
  headers: {
    Authorization: `Bearer ${ACCESS_TOKEN}`,
  },
});

Python

import requests

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

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