API 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. Đối với tài khoản trả trước: Số dư khả dụng còn đủ để thực hiện cuộc gọi (bảng giá dịch vụ)

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

Chi tiết API

Thêm danh sách liên hệ sẽ gọi

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

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

{
  "result": [
    {
      "contact_id": "f95c4831-bc9d-4626-8713-a0a161cee01e",
      "danh_xung": "Anh",
      "ho_ten": "David Thiêm",
      "so_dien_thoai": "[phone]"
    }
  ],
  "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

contacts

Tham số	Kiểu dữ liệu	Bắt buộc	Mô tả
phone_number	String	Có	Số điện thoại của khách gọi tới
ho_ten	String	Không	Tên khách hàng gọi tới (thẻ cá nhân hóa)

Ngoài tham số bắt buộc phone_number, mỗi liên hệ sẽ có thêm các giá trị của các thẻ cá nhân hóa (nếu có) khi bạn biên tập kịch bản cho chiến dịch. Ví dụ: thẻ cá nhân hóa ho_ten.

Kết quả trả về các liên hệ được thêm vào chiến dịch thành công. Mỗi liên hệ sẽ được đặt định danh là contact_id.

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ệ
1104	Portal wallet is expired	Số dư hết hạn sử dụng (đối với tài khoản trả trước)
1105	Portal wallet is out of money	Số dư không đủ để thực hiện cuộc gọi (đối với tài khoản trả trước)
1201	Application is not found	Không tìm thấy ứng dụng (kiểm tra lại thông tin API_KEY)
1208	Scenario content is empty	Nội dung kịch bản gọi ra trống
1402	Import contacts failed	Thêm khách hàng thất bại
1403	All contacts is invalid	Tất cả các khách hàng không hợp lệ (Kiếm tra lại trường phone_number)
2301	Pool hotline is not available	Pool hotline không khả dụng
9999	Unknown error	Lỗi phát sinh của hệ thống

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}/calls`,
  headers: {
    Authorization: `Bearer ${ACCESS_TOKEN}`,
  },
  data: {
    contacts: [
        {
            phone_number: "0987654321",
        }
    ]
  },
});

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}/calls',
    headers={
        "Authorization": f'Bearer {ACCESS_TOKEN}'
    },
    json={
        "contacts": [
            {
                "phone_number": "0987654321"
            }
        ]
    }
)

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>";
        String data = "{\"contacts\": [{\"phone_number\": \"0987654321\"}]}";

        RequestBody requestBody = RequestBody.create(MediaType.parse("application/json"), data);
        
        Request request = new Request.Builder()
                .url("https://aicall.vbee.ai/api/v1/public-api/scenarios/" + SCENARIO_ID + "/calls")
                .header("Authorization", "Bearer " + ACCESS_TOKEN)
                .post(requestBody)
                .build();

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

PHP

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

$data = [
   "contacts" => [
      [
         "phone_number" => "0987654321"
      ]
   ]
];

$ch = curl_init('https://aicall.vbee.ai/api/v1/public-api/scenarios/' . $SCENARIO_ID . '/calls');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
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);