Version
GET

Get a recovery's roll call

/v1/recovery/operations/{operation}/roll-call in the Disaster Recovery API.

curl https://api.subscriby.net/v1/recovery/operations/$OPERATION_ID/roll-call \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

Where the re-admission after a channel recovery stands, read live.

  • total is how many members the swap set out to re-admit; regranted how many hold a fresh link into the new chat; failed how many could not be given one.
  • unreachable is how many the bot could not message, and emailed how many of those were told by email instead (at the per-email fee, when the project opted in).
  • joined is stamped the moment the platform approves a member's join request, so pending (regranted − joined) is who is still outside.
  • settled means the queue has handled everyone, so the counters will not move on their own. can_nudge is true when somebody is still outside and the reminder cooldown has passed; cooling_down and nudge_available_at explain a false.

A recovery of a kind that re-admits nobody (an account relink, a bot replacement) answers the same shape with every counter at zero rather than an error.

GET
/v1/recovery/operations/{operation}/roll-call

Requires ability

The token must hold this ability, or the call is refused with 403.

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken
AuthorizationBearer <token>

A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.

In: header

Path Parameters

operation*string

The operation, resolved within the ledger by the route binder.

Formatuuid

Responses

200OK

200 with the counters.

401Unauthorized

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

403Forbidden

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.

404Not found

An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.

429Too many requests

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

How is this guide?

Last updated on