API Reference

Getting Started

Recover an offline account

Check authorization and connection separately. Continue authorization when needed; choose runtime actions after inspecting the current state.

Getting started

  1. 1

    Get authentication state

    Check authorization and connection separately. Continue authorization when needed; choose runtime actions after inspecting the current state.

    curl -X GET "https://api.unifyport.ai/v1/accounts/{account_id}/auth" \
      -H "X-Api-Key: <YOUR_API_KEY>"
    Account lifecycle
  2. 2

    Refresh runtime state

    Read runtime_status in the response. starting or reconnecting needs another state check. If auth_required is true, continue authorization; absence of this hint does not prove the account is online.

    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 '{}'
    Refresh runtime state
  3. 3

    Understand the result

    If authorization needs action, follow the corresponding channel guide. If authorized but stopped, start runtime; if disconnected, refresh state first and reconnect only if that channel supports it. Query the account again until runtime_status is running before resuming sends.

    Start runtime