Consultar grupo

Cache de 10 min; force=true atualiza. getInviteLink só retorna link para administrador. getRequestsParticipants ignorado.

Autenticação

Header obrigatório: token. Use o token da instância.

Base URL: a API do servidor selecionado, como https://1.atendro.cloud. O domínio wpp.atendro.cloud hospeda a documentação e o console.

Headers adicionais

Campo	Tipo	Presença	Descrição
`X-Request-Id`	`string`	opcional	ASCII visível sem espaços, 1–128 caracteres. Inválido/ausente é substituído por UUID. Ecoado na resposta. Comprimento máximo: `128`

Corpo da requisição

Formato: application/json. Corpo obrigatório.

Campo	Tipo	Presença	Descrição
`groupjid`	`string`	obrigatório	Identificador do grupo terminado em @g.us. Comprimento mínimo: `1`
`force`	`boolean / string / integer / null`	opcional	—
`getInviteLink`	`boolean / string / integer / null`	opcional	—
`getRequestsParticipants`	`any`	opcional	Aceito e ignorado.

Respostas

Consultar grupo

Campo	Tipo	Presença	Descrição
`JID`	`string`	obrigatório	—
`Name`	`string`	obrigatório	—
`Topic`	`string`	opcional	—
`OwnerJID`	`string`	opcional	—
`OwnerPN`	`string`	opcional	—
`IsLocked`	`boolean`	opcional	—
`IsAnnounce`	`boolean`	opcional	—
`AddressingMode`	`string`	opcional	—
`ParticipantCount`	`integer`	obrigatório	—
`Participants`	`array<object>`	opcional	—
`Participants[].JID`	`string`	obrigatório	—
`Participants[].PhoneNumber`	`string`	opcional	—
`Participants[].LID`	`string`	opcional	—
`Participants[].IsAdmin`	`boolean`	obrigatório	—
`Participants[].IsSuperAdmin`	`boolean`	obrigatório	—
`Participants[].DisplayName`	`string`	obrigatório	—
`Participants[].Error`	`integer`	obrigatório	Código por participante; 0 indica ausência de erro registrado.
`invite_link`	`string`	obrigatório	Vazio se não solicitado ou sem permissão de admin.
`PictureID`	`string`	opcional	—
`lastMessageAt`	`integer`	opcional	Unix em segundos. Formato: `int64`
`syncedAt`	`integer`	opcional	Unix em segundos. Formato: `int64`
`left`	`boolean`	opcional	—
`GroupCreated`	`string`	opcional	RFC 3339. Formato: `date-time`

Grupo, participantes, nome ou imagem inválidos.

Campo	Tipo	Presença	Descrição
`error`	`string`	obrigatório	—
`message`	`string`	opcional	—
`messageid`	`string`	opcional	ID para reconciliação quando o resultado é ambíguo.
`messageId`	`string`	opcional	—
`id`	`string`	opcional	—
`provider_code`	`integer`	opcional	—
`error_key`	`string`	opcional	—
`error_source`	`string`	opcional	—
`details`	`object`	opcional	—
`instance`	`object`	opcional	Modelo: Instance.

unauthorized: header ausente, inválido ou duplicado. Bearer/query/instancekey não substituem admintoken/token.

Campo	Tipo	Presença	Descrição
`error`	`string`	obrigatório	—
`message`	`string`	opcional	—
`messageid`	`string`	opcional	ID para reconciliação quando o resultado é ambíguo.
`messageId`	`string`	opcional	—
`id`	`string`	opcional	—
`provider_code`	`integer`	opcional	—
`error_key`	`string`	opcional	—
`error_source`	`string`	opcional	—
`details`	`object`	opcional	—
`instance`	`object`	opcional	Modelo: Instance.

not_in_group ou not_admin.

Campo	Tipo	Presença	Descrição
`error`	`string`	obrigatório	—
`message`	`string`	opcional	—
`messageid`	`string`	opcional	ID para reconciliação quando o resultado é ambíguo.
`messageId`	`string`	opcional	—
`id`	`string`	opcional	—
`provider_code`	`integer`	opcional	—
`error_key`	`string`	opcional	—
`error_source`	`string`	opcional	—
`details`	`object`	opcional	—
`instance`	`object`	opcional	Modelo: Instance.

group_not_found.

Campo	Tipo	Presença	Descrição
`error`	`string`	obrigatório	—
`message`	`string`	opcional	—
`messageid`	`string`	opcional	ID para reconciliação quando o resultado é ambíguo.
`messageId`	`string`	opcional	—
`id`	`string`	opcional	—
`provider_code`	`integer`	opcional	—
`error_key`	`string`	opcional	—
`error_source`	`string`	opcional	—
`details`	`object`	opcional	—
`instance`	`object`	opcional	Modelo: Instance.

Sessão desconectada/ocupada.

Campo	Tipo	Presença	Descrição
`error`	`string`	obrigatório	—
`message`	`string`	opcional	—
`messageid`	`string`	opcional	ID para reconciliação quando o resultado é ambíguo.
`messageId`	`string`	opcional	—
`id`	`string`	opcional	—
`provider_code`	`integer`	opcional	—
`error_key`	`string`	opcional	—
`error_source`	`string`	opcional	—
`details`	`object`	opcional	—
`instance`	`object`	opcional	Modelo: Instance.

rate_limited, Retry-After=30.

Campo	Tipo	Presença	Descrição
`error`	`string`	obrigatório	—
`message`	`string`	opcional	—
`messageid`	`string`	opcional	ID para reconciliação quando o resultado é ambíguo.
`messageId`	`string`	opcional	—
`id`	`string`	opcional	—
`provider_code`	`integer`	opcional	—
`error_key`	`string`	opcional	—
`error_source`	`string`	opcional	—
`details`	`object`	opcional	—
`instance`	`object`	opcional	Modelo: Instance.

storage_unavailable (Retry-After=5). Algumas rotas também retornam 502 por falha da conexão/mídia; consultar error.

Campo	Tipo	Presença	Descrição
`error`	`string`	obrigatório	—
`message`	`string`	opcional	—
`messageid`	`string`	opcional	ID para reconciliação quando o resultado é ambíguo.
`messageId`	`string`	opcional	—
`id`	`string`	opcional	—
`provider_code`	`integer`	opcional	—
`error_key`	`string`	opcional	—
`error_source`	`string`	opcional	—
`details`	`object`	opcional	—
`instance`	`object`	opcional	Modelo: Instance.

Falha; usar HTTP status e error. 404 rota inexistente; 405 método inválido com Allow. Ver catálogo no guia de integração.

Campo	Tipo	Presença	Descrição
`error`	`string`	obrigatório	—
`message`	`string`	opcional	—
`messageid`	`string`	opcional	ID para reconciliação quando o resultado é ambíguo.
`messageId`	`string`	opcional	—
`id`	`string`	opcional	—
`provider_code`	`integer`	opcional	—
`error_key`	`string`	opcional	—
`error_source`	`string`	opcional	—
`details`	`object`	opcional	—
`instance`	`object`	opcional	Modelo: Instance.

curl --request POST "$ATENDROZAP_URL/group/info" \ --header "token: $ATENDROZAP_INSTANCE_TOKEN" \ --header "Content-Type: application/json" \ --data '{ "groupjid": "120363000000000001@g.us", "force": false }'