账号

创建账号

创建渠道账号。auth_mode 必填且仅可为 qrcode、code 或 session。当 provider 与 auth_mode 组合要求手机号时（例如 WhatsApp + auth_mode=code），必须通过 provider_data.phone 提供；该值会持久化并在后续认证动作中复用。

POSThttps://api.unifyport.ai/v1/accounts

支持的渠道

all

调用前准备

在服务端使用资源所属工作区的 X-Api-Key。运行示例前替换所有占位符。

请求

curl -X POST "https://api.unifyport.ai/v1/accounts" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Telegram Production",
  "provider": "telegram",
  "region": "<REGION>",
  "auth_mode": "qrcode",
  "capabilities": ["send_message", "receive_message"]
}'

请求参数

请求头

X-Api-Key

string必填

工作区 API Key，工作区由该请求头解析得到。

Content-Type

string必填

发送 JSON 请求体时使用 application/json。

请求体

name

string

可读的账号名称。

provider

string必填

客户可用的渠道标识：telegram、whatsapp、whatsapp-protocol、line、twitter、zalo 或 tiktok。

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp-protocol, x, x_client, twitter_client

region

string必填

用于分配的渠道区域。请通过列出渠道区域选择 allocatable: true 的区域。

minLength: 1

status

string

账号业务状态，例如 active 或 inactive。

runtime_status

string

渠道支持通过账号配置修改时，请求设置的运行时状态。

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

auth_mode

string必填

创建账号时必填；认证流程仅可为 qrcode、code 或 session。

enum: qrcode, code, session

capabilities[]

string[]

账号能力列表。PATCH 时省略表示保留，传 [] 表示清空，null 非法。

metadata

object

平台侧元数据。PATCH 时省略表示保留，传 {} 表示清空，null 非法。

provider_account_ref

string

渠道侧账号标识，通常在授权完成后由系统写入。

provider_data

object

渠道配置。PATCH 时省略表示保留，{} 清空且不补充默认凭证，null 非法。TikTok provider_data.enable_comment 仅接受 Boolean，默认 false；字符串、数字、null 返回 400 invalid_request。在线修改需 reconnect，start 成功不证明配置已应用；关闭不撤回已排队事件。Telegram 的 code、qrcode、session 均可省略 api_id 和 api_hash；自定义凭证须为同一应用的成对字符串。创建时未指定自定义凭证、非空配置替换时缺省凭证字段，均使用平台默认值；所需默认配置不可用时请求失败。平台默认凭证变更不会替换已有账号凭证。请勿记录密钥。

proxy

object

该账号可选的出站代理配置。

如何理解结果

201 表示账号资源已创建。将 data.id 保存为 account_id，继续所选渠道的授权流程；创建账号不表示授权完成或连接已在线。

响应 201 Created

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "id": "acc_example",
    "name": "Telegram Production",
    "provider": "telegram",
    "region": "<REGION>",
    "status": "active",
    "runtime_status": "stopped",
    "auth_mode": "qrcode",
    "capabilities": [
      "send_message",
      "receive_message"
    ]
  }
}

响应体

provider_profile

object

渠道上报的资料，例如 display_name；账号认证完成前不返回。

id

string

渠道侧账号标识。WhatsApp 返回 LID；账号资料同步完成前可能省略。

device_id

integer

仅 WhatsApp 账号详情在可确认当前会话时提供的可选登录设备编号；重新授权后可能变化，不作为永久设备标识。

minimum: 0 · maximum: 65535

phone

string

已归一化的账号手机号，不含空格、连字符和开头加号。

username

string

渠道上报的用户名（如有）。

display_name

string

账号展示名称；WhatsApp 按 BusinessName 优先、PushName 回退的规则生成。

push_name

string

WhatsApp 当前账号设置的 PushName；其他渠道不定义该字段语义。

business_name

string

WhatsApp BusinessName；渠道未返回时该字段缺失。

first_name

string

渠道上报的名字（如有）。

last_name

string

渠道上报的姓氏（如有）。

avatar_url

string

渠道上报的账号头像 URL（如有）。

bio

string

渠道上报的账号简介或状态文本（如有）。

platform

string

WhatsApp 配对时上报的登录平台标识。请将其视为不透明字符串并兼容未知值；其他渠道不定义该字段语义。该字段与 device_platform 不同。

id

string

账号唯一标识（acc_...），用于账号维度的路由。

name

string

可读的账号名称。

provider

string

渠道标识。调用其他接口时原样使用 API 返回的值；此接口的返回范围见下方枚举。

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp-protocol

region

string

该账号被分配到的渠道区域。

status

string

账号生命周期状态，例如 active。

runtime_status

string

标准化的运行时状态，取值之一：unknown、starting、running、stopping、stopped、reconnecting、disconnected 或 error。

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

auth_mode

string

账号使用的认证流程：code、qrcode 或 session。

capabilities[]

string[]

账号已启用的能力，例如 send_message 与 receive_message。

metadata

object

存储在账号上的自有环境标签。

provider_account_ref

string

渠道侧标识，可附加用于将该账号与你自有系统关联。

proxy

object

账号绑定的出站代理配置，未配置时省略。

响应

201

201 Created

请求成功，响应体示例如上。

400

请求错误

请求体、路径或参数不合法。

401

未授权

X-Api-Key 请求头缺失或无效。

409

冲突

当前操作与已有的渠道账号或资源冲突。

500

服务端错误

服务端遇到了未预期的错误。

503

服务不可用

所需的后端服务暂时不可用。

失败后怎么处理

检查 HTTP 状态和 error.code/numeric_code，保存 request_id 用于排查。按原因修正参数、继续授权或检查运行态。重试发送及其他写操作前先确认上一次结果，避免重复操作。错误码参考

invalid_request · 10000 · 400: 检查必填字段、格式和渠道条件，修正请求后再调用。
missing_api_key · 11000 · 401: 检查 X-Api-Key 是否正确、工作区是否有效。
invalid_api_key · 11001 · 401: 检查 X-Api-Key 是否正确、工作区是否有效。