OpenAPI 接口文档
OpenAPI 接口文档

启用或停用动态子账号

设置调用方期望的动态子账号启用状态。状态变化可能需要短暂时间才能完全生效。

接口信息

项目 内容
Method PATCH
Path /open-api/v1/dynamic/accounts/{id}/status
认证 X-API-Key
Content-Type application/json
处理方式 同步受理状态变更

路径参数

参数 类型 必填 说明
id string 动态子账号 ID

请求体

字段 类型 必填 说明
user_enabled boolean true 表示启用,false 表示停用

必须使用 JSON boolean,不能发送字符串 "true" 或数字 1

请求示例

curl --request PATCH \
  --url 'https://api-test.puraroute.com/gin/open-api/v1/dynamic/accounts/1912345678901234567/status' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <YOUR_API_KEY>' \
  --data '{
    "user_enabled": false
  }'

响应参数

字段 类型 说明
id string 动态子账号 ID
resource_status string ACTIVEREMOVED
user_enabled boolean 调用方期望启用状态
flow_blocked boolean 是否因流量余额条件而暂停使用
available boolean 当前是否满足使用条件
control_pending boolean true 表示状态变化仍在生效过程中

成功响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "id": "1912345678901234567",
    "resource_status": "ACTIVE",
    "user_enabled": false,
    "flow_blocked": false,
    "available": false,
    "control_pending": true
  },
  "next": null
}

control_pending = true 时,可稍后查询账号详情,直到该字段变为 falseuser_enabled = true 也不保证 available = true;仍需同时检查流量条件。

可能的错误码

code 说明
300001 账号不存在或不可访问
300328 账号已移除,不能继续变更
400001 认证失败
400009 路径、布尔值或请求体不符合要求
500000 系统处理失败,请求未完成

On this page