Tham chiếu API
Môi trường chạyPOST

Refresh trạng thái runtime

Đồng bộ trạng thái runtime mới nhất của nhà cung cấp cho tài khoản. runtime_status nhận một trong các giá trị chuẩn của nền tảng: unknown, starting, running, stopping, stopped, reconnecting, disconnected, error. Các nhãn riêng của từng provider được chuẩn hoá về tập giá trị này trước khi trả về.

https://api.unifyport.ai/v1/accounts/{account_id}/runtime/refresh

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

account_id
stringbắt buộc

Định danh dùng cho route runtime.

Nội dung yêu cầu

Điểm cuối này nhận một đối tượng JSON rỗng; hãy gửi {} như trong ví dụ yêu cầu.

Nội dung phản hồi

account_id
string

Tài khoản nhà cung cấp mà phản hồi này tham chiếu tới.

provider
string

Provider có runtime xử lý hành động.

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp_protocol

action
string

Hành động runtime đã yêu cầu.

enum: refresh_status, start, stop, reconnect

operation_status
string

Trạng thái cho biết hành động runtime đã được chấp nhận hoặc hoàn tất.

runtime_status
string

Trạng thái runtime đã chuẩn hoá: một trong unknown, starting, running, stopping, stopped, reconnecting, disconnected hoặc error.

enum: unknown, starting, running, stopping, stopped, reconnecting, disconnected, error

runtime_error
string

Lỗi runtime của provider khi hành động không thể hoàn tất.

Phản hồi

200
200 OK

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ệ.

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.

502
Bad Gateway

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

Yêu cầu

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

Phản hồi

{
  "data": {
    "account_id": "acc_example",
    "runtime_status": "running"
  }
}