ReferenceParceiro
Consultar pedido de link de convite
Devolve o estado atual do pedido e de cada grupo. Consulte, respeitando o Retry-After, até
status ser final (completed, completed_with_errors, failed, cancelled ou expired).
Só o app que criou o pedido o vê.
Authorization
PartnerOAuth group_invite_links:readAuthorizationBearer <token>
OAuth 2.0 (Authorization Code + PKCE) para apps de parceiro. O
access_token opaco (orb_at_...) vai no header
Authorization: Bearer. Cada operação exige os scopes que o usuário
consentiu; scopes integrations:* nunca são concedíveis a parceiro.
In: header
Scope: group_invite_links:read
Path Parameters
id_group_invite_link_job*string
ID do pedido de link de convite (formato group_invite_link_job_<uuid>).
Length
length <= 100Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/external/partner/group-invite-link-job/string"{ "success": true, "id_group_invite_link_job": "string", "status": "queued", "summary": { "total": 0, "ready": 0, "queued": 0, "processing": 0, "failed": 0, "skipped": 0, "cancelled": 0, "expired": 0 }, "items": [ { "index": 0, "group_ref": "string", "status": "queued", "invite_link": "string", "channel_ref": "string", "cached": true, "fetched_at": "2019-08-24T14:15:22Z", "error": { "code": "string", "message": "string", "retryable": true } } ], "created_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z"}{ "success": false, "error": "Unauthorized", "message": "Chave de API inválida ou ausente."}{ "success": false, "error": "Forbidden", "code": "unsupported_credential", "message": "Esta credencial não pode consultar link de convite de grupo."}{ "success": false, "error": "Not Found", "code": "group_invite_link_job_not_found", "message": "Pedido não encontrado."}{ "success": false, "error": "Too Many Requests", "code": "too_many_active_jobs", "message": "Muitos pedidos agora. Tente de novo em instantes."}{ "success": false, "error": "Service Unavailable", "code": "temporary_error", "message": "Não foi possível concluir agora. Tente novamente em instantes."}