Cuộc gọi

Kết thúc cuộc gọibeta

Tính năng này đang trong giai đoạn thử nghiệm kín. Hãy liên hệ bộ phận hỗ trợ kỹ thuật để yêu cầu cấp quyền cho không gian làm việc.

Hiện chỉ hỗ trợ cuộc gọi thoại và video một đối một trên WhatsApp. Dùng account_id và call_id để kết thúc. Nếu quên ID, hãy lấy cuộc gọi hiện tại trước.

POSThttps://api.unifyport.ai/v1/calls/{call_id}/hangup

Kênh được hỗ trợ

Trước khi gọi

Dùng X-Api-Key của workspace sở hữu tài nguyên trên máy chủ. Thay mọi giá trị mẫu trước khi chạy.

Xác nhận không gian làm việc có quyền thử nghiệm kín. Trước khi tạo cuộc gọi, hoàn tất xác thực WhatsApp và kiểm tra runtime_status=running. Dùng conversation_id của hội thoại riêng thuộc tài khoản này.

Nguồn tham số

account_id: Lấy data.id từ phản hồi tạo hoặc truy vấn tài khoản. ID thuộc workspace của X-Api-Key. Lấy tài khoản
call_id: Dùng call_id trả về khi tạo hoặc truy vấn cuộc gọi hiện tại của tài khoản này. Nếu mất ID, truy vấn cuộc gọi hiện tại trước khi kết thúc. Lấy cuộc gọi hiện tại

Yêu cầu

curl -X POST 'https://api.unifyport.ai/v1/calls/call_example/hangup' \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "account_id": "acc_example"
}'

Tham số yêu cầu

Tiêu đề

X-Api-Key

stringbắt buộc

API key của không gian làm việc. Không gian làm việc được xác định từ tiêu đề này.

Content-Type

stringbắt buộc

Dùng application/json khi gửi nội dung yêu cầu JSON.

Tham số đường dẫn

call_id

stringbắt buộc

Định danh dùng cho route calls.

maxLength: 128 · pattern: ^[A-Za-z0-9][A-Za-z0-9_-]*$

Nội dung yêu cầu

account_id

stringbắt buộc

ID tài khoản trong không gian làm việc hiện tại.

pattern: ^acc_[A-Za-z0-9][A-Za-z0-9_-]*$

Hiểu kết quả

Đọc call_id và state trả về. ended và failed đều là trạng thái kết thúc của cuộc gọi; yêu cầu kết thúc lặp lại có thể trả trạng thái kết thúc đã có. HTTP 200 không nhất thiết là state=ended; không tự động thử lại chỉ vì state=failed.

Phản hồi 200 · 200

{
  "request_id": "req_example",
  "data": {
    "call_id": "call_example",
    "state": "ended",
    "direction": "outbound",
    "media_type": "voice"
  }
}

Nội dung phản hồi

call_id

string

Mã cuộc gọi, cũng dùng để kết thúc.

maxLength: 128

state

string

Trạng thái cuộc gọi hiện tại.

enum: ended, failed

direction

string

Hướng cuộc gọi.

enum: inbound, outbound

media_type

string

voice là âm thanh; video là cuộc gọi có hỗ trợ video.

enum: voice, video

Phản hồi

200

200 · 200

Yêu cầu thành công. Xem ví dụ nội dung phản hồi.

400

Bad Request

Body, đường dẫn hoặc tham số yêu cầu không hợp lệ.

401

Unauthorized

Header X-Api-Key thiếu hoặc không hợp lệ.

403

Forbidden

Yêu cầu đã được nhận diện nhưng thao tác không được phép.

404

Not Found

Không tìm thấy tài nguyên được yêu cầu. Kiểm tra error.code cùng với thao tác hiện tại.

409

Conflict

Thao tác đang yêu cầu xung đột với tài khoản hoặc tài nguyên nhà cung cấp đã có.

500

Internal Server Error

Dịch vụ gặp lỗi không mong muốn.

501

Not Implemented

Provider đã chọn chưa triển khai thao tác này.

502

Bad Gateway

Adapter hoặc upstream provider không thể hoàn tất thao tác.

503

Service Unavailable

Dịch vụ backend cần thiết tạm thời không khả dụng.

Khi yêu cầu thất bại

Kiểm tra HTTP và error.code/numeric_code; giữ request_id. Kiểm tra quyền thử nghiệm, tài khoản và call_id. Nếu tạo bị xung đột, truy vấn cuộc gọi hiện tại trước. Xác nhận trạng thái trước khi thử lại thao tác tạo hoặc kết thúc. Tham chiếu mã lỗi

invalid_request · 10000 · 400: Kiểm tra trường bắt buộc, định dạng và điều kiện kênh rồi sửa yêu cầu.
missing_api_key · 11000 · 401: Kiểm tra X-Api-Key và workspace còn hoạt động.
invalid_api_key · 11001 · 401: Kiểm tra X-Api-Key và workspace còn hoạt động.
account_not_found · 20020 · 404: Kiểm tra account_id và dùng X-Api-Key của không gian làm việc sở hữu tài khoản. Khóa hiện tại không truy cập được tài khoản không tìm thấy trong không gian này.
unsupported_by_provider · 30003 · 501: Xem hướng dẫn khả năng kênh và chọn kênh hoặc thao tác được hỗ trợ. Gửi lại không bổ sung hỗ trợ.
beta_feature_not_enabled · 41002 · 403: Liên hệ hỗ trợ kỹ thuật để xin quyền thử nghiệm kín cho không gian làm việc. Gửi lại hoặc sửa is_beta trong yêu cầu không cấp quyền.
call_not_found · 38003 · 404: Kiểm tra HTTP và error.code/numeric_code; giữ request_id. Kiểm tra quyền thử nghiệm, tài khoản và call_id. Nếu tạo bị xung đột, truy vấn cuộc gọi hiện tại trước. Xác nhận trạng thái trước khi thử lại thao tác tạo hoặc kết thúc.