Login Cadastre-se

Listar membros do grupo

Endpoint: GET https://croncrm.com/api/v2/groups/get-members

Retorna a lista de participantes de um grupo.

Header do request
Atributo Descrição Obrigatório Tipo

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String
Query do request
Atributo Descrição Obrigatório Tipo

chat_wid

Informe o WID do grupo.

Sim

String

page

Página da listagem.

Não

Inteiro

 
GET /api/v2/groups/[email protected]&page=1
Response do request

Em caso de sucesso, retorna HTTP 200 com success true. Se chat_wid não for informado, retorna 422. Se chat_wid for inválido, retorna 400. Se o grupo não for encontrado, retorna 404. Método incorreto retorna 405; falhas inesperadas retornam 500.

Atributo Descrição Tipo

success

Informa se a operação teve sucesso ou não.

Boolean

msg

Mensagem de retorno.

String

page

Página atual.

Inteiro

pages

Total de páginas.

Inteiro

limit

Limite de itens por página.

Inteiro

count

Total de registros.

Inteiro

participants

Lista de participantes.

Array|null

 
{
  "success": true,
    "msg": "Consulta realizada com sucesso.",
  "page": 1,
  "pages": 1,
  "limit": 20,
  "count": 5,
  "participants": [
    {
      "wid": "[email protected]",
            "wuser": "5599...",
            "wserver": "c.us",
            "name": "Contato A"
    }
  ]
}
 
<?php
$apiKey = 'SEU_API_KEY';
$baseUrl = 'https://croncrm.com/api/v2/groups/get-members';

$query = [
    'chat_wid' => '[email protected]',
    'page' => 1,
];

$url = $baseUrl . '?' . http_build_query($query);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'apiKey: ' . $apiKey,
    ],
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$error = curl_error($ch);
curl_close($ch);

if ($error) {
    throw new RuntimeException($error);
}

echo "HTTP {$httpCode}\n";
echo $response;
?>
curl -G \
  'https://croncrm.com/api/v2/groups/get-members' \
  -H 'apiKey: SEU_API_KEY' \
  --data-urlencode '[email protected]' \
  --data-urlencode 'page=1'