Tạo link gọi thoại outbound từ OA đến người dùng

Lưu ý

Ứng dụng cần được OA cấp quyền sử dụng chức năng gọi thoại

HTTP request

• URL: https://openapi.zalo.me/v3.0/oa/call/outbound
• Method: POST
• Content Type: application/json
• Response Type: text/json

Example request

curl --location 'https://openapi.zalo.me/v3.0/oa/call/outbound' \
--header 'access_token: <oa_access_token>' \
--header 'Content-Type: application/json' \
--data '{
    "user_id": "4491783511907164918",
    "agent_id": "5931518706854365424", //optional
    "call_type": "audio" // audio + video + audio_and_video
}'

Tham số header

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
access_token	string	yes	Token cho phép ứng dụng đại diện OA gọi API. Xem chi tiết cách lấy access token tại đây.

Cấu trúc body của request

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
user_id	string	yes	user_id của người dùng muốn gọi đến
agent_id	string	no	agent_id: là user_id của tổng đài viên được chỉ định để thực hiện cuộc gọi đến người dùng
call_type	number	yes	Loại cuộc gọi muốn thực hiện. Danh sách giá trị: · audio: Cuộc gọi thoại · video: Cuộc gọi video · audio_and_video: Cả gọi thoại và video

Example respond

{
    "data": {
        "call_link": "https://zalo.me/app/link/hgvnnan0af",
        "qr_code": "https://qr-talk.zdn.vn/1/hgvnnan0af/1787a359799c90c2c98d.jpg",
        "ttl": 172800
    },
    "error": 0,
    "message": "Success"
}

Cấu trúc thuộc tính data

Thuộc tính	Kiểu dữ liệu	Mô tả
call_link	string	Link để thực hiện cuộc gọi
qr_code	string	Hình QR Code thực hiện cuộc gọi
ttl	integer	Thời gian tồn tại của call_link và qr_code, tính bằng giây