GET/api/v4/social/limits

获取 Social 套餐限额和用量

返回该账户的 Social 连接上限,以及当前计费周期内的计费连接用量、活跃连接用量和已释放连接用量。

需要 API 密钥。请求头格式和密钥轮换请参阅身份验证。

参数

此端点不接受任何参数。

响应

200The account's Social caps and current usage. `brands` is null because brands are unlimited on API plans. Here 118 connections are billable: 112 still connected, plus 6 disconnected during this period whose slots are held until renewal.
Response
{  "data": {    "fetchAccountLimits": {      "brands": null,      "connections": 135,      "maxConnections": 135,      "users": 10,      "aiCredits": 500,      "usage": {        "brands": 31,        "connections": 118,        "connectionsActive": 112,        "connectionsReleased": 6      }    }  }}
401Unauthenticated, missing or invalid API key.

返回您的 Social 套餐允许的额度,以及您已使用的额度。请在签发连接链接之前读取这些信息,以便在客户没有剩余额度时告知他们,而不是在写入失败后显示 SY95042。

字段含义
brands品牌额度。所有 API 套餐均为 null,表示不设上限。此处的任何 null 都应视为“无上限”,而不是零。
connections订阅包含的连接数,即套餐级别自带的连接数加上已购买的所有连接包提供的连接数。
maxConnections建立连接时实际执行的上限。在 API 套餐中,它等于 connections。
users套餐包含的席位数。
aiCredits当前周期包含的内容生成额度。
usage.brands当前存在的品牌数。仅供参考,无需与任何上限比较。
usage.connections计费连接数,也是唯一受上限约束的数量。当前计费周期内任意时间使用过的不同连接数:仍处于连接状态的连接加上本周期内已释放的连接。请将此值与 maxConnections 比较。
usage.connectionsActive当前处于连接状态的连接数。始终小于或等于 usage.connections。适合用于向客户展示哪些连接当前在线;并非向他们计费所依据的数量。
usage.connectionsReleased在当前计费周期内断开、但仍保留名额的连接数。这部分容量会在续订时恢复。

usage.connections 恰好等于 usage.connectionsActive + usage.connectionsReleased。

已释放的名额会保留至周期结束

断开渠道连接会使其立即离线,但不会归还名额。在一个计费周期内,上限计算的是您使用过的不同连接数,无论这些连接是否仍处于连接状态,因此名额会一直被占用,直到订阅续订。代码中应考虑以下 3 点影响:

  • 剩余额度为 maxConnections - usage.connections,绝不是 maxConnections - usage.connectionsActive。使用活跃连接数计算会让客户误以为仍有额度,而下一次请求连接链接时将返回 SY95042。
  • 将同一账号重新连接到同一品牌是免费的。如果客户重新连接了本周期内先前从该品牌断开的主页,则会复用其已占用的名额:connectionsActive 增加,connectionsReleased 减少,而 connections 保持不变。将同一主页关联到另一个品牌会占用一个单独的名额,而原名额仍会保留至续订。
  • connectionsReleased 是您的续订预测值。它恰好表示进入下一个周期时归还到共享池的名额数,应向正在决定是等待续订还是立即购买连接包的客户展示此值。

这与计费模型的其余部分遵循相同的规则:您购买的容量立即可用,而您放弃的容量在周期结束时移除。请参阅套餐和附加项。

使用场景:在您的开通流程中预先检查。在向客户显示“连接账号”按钮之前,请将 usage.connections(计费连接数,而非 connectionsActive)与 maxConnections 比较。如果没有剩余额度,请向他们展示购买附加项或升级的途径,而不是让 POST /social/brands/{brandId}/connections/link 失败。品牌无需类似检查:使用 POST /social/brands 创建品牌时,永远不会遇到额度不足的情况。

使用场景:确定下一次购买的附加项数量。连接包以每包 5 个连接的形式出售,因此 maxConnections - usage.connections 直接表示您还可以连接多少个社交网络,而 ceil((needed - headroom) / 5) 表示需要购买多少个连接包。

注意事项。

  • 品牌不设数量上限,也不计量。对于 listingsAPI 账户,brands 返回 null。之前将其视为整数上限的客户端代码必须处理 null,并且不应显示“剩余 0 个品牌”。
  • 连接是同一账户内共享的资源池,而不是按品牌分配的额度。只要共享池仍有额度,一个品牌就可以按需建立连接,最多可连接其支持的 5 个社交网络。请参阅套餐和附加项。
  • 此端点仅涵盖 Social 订阅。地点上限属于 Listings 订阅,由 POST /locations 单独执行;当账户完全没有 Listings 套餐时,该端点返回 SY10155。
  • 自助服务账户的连接上限为 250 个,无论购买多少连接包都不例外。若需超过此上限,账户必须迁移至 Enterprise。
  • 有剩余容量并不保证能连接 Instagram。Instagram 仅允许连接已关联 Facebook 主页的商业账号或创作者账号;个人账号会在 Meta 的授权页面被拒绝,而不是被此上限阻止。如果客户在此处仍有额度,但请求 Instagram 的连接链接仍然失败,则需要转换账号类型,而不是增加容量。
  • 这些数字实时更新,但释放连接并不意味着退款。使用 disconnect 断开连接或归档品牌后,下次读取时就会在此处体现为 usage.connectionsActive 减少,usage.connectionsReleased 相应增加。usage.connections 保持不变,因为名额会保留至周期结束。两种释放途径的行为完全相同。
Request
curl -X GET 'https://listingsapi.com/api/v4/social/limits' \  -H "Authorization: API $LISTINGSAPI_KEY"