API Request to Retrieve Unread Counts for Private Messages, Site Notifications, and Group Notifications

Request URL
https://yourgrupowebsiteaddress/api_request/

Request body

FieldDescription/ValuesRequired/Optional
api_secret_keyYour Grupo API Secret Key. For API Secret Key, Click on Menu > Select Settings > Select General Settings > Find API Secret KeyRequired
realtimetrueRequired
userUsername/Email Address of the User AccountRequired

Response Body

KEYDescription/Values
successThis returns true on success and false on failure.
error_messageReturns a relevant error message
error_keyThis method returns the error key associated with the error

Example PHP Code

<?php

$grupo_web_address = 'https://yourgrupowebsiteaddress'; 

$post_fields=[
  'api_secret_key' => 'Your_Grupo_API_Secret_Key',
  'realtime' => true,
  'user' => 'username/email_address'
];

$api_request_url = rtrim($grupo_web_address, '/').'/'.'api_request/';

$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => $api_request_url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => $post_fields,
  CURLOPT_USERAGENT=>'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:99.0) Gecko/20100101 Firefox/99.0'
));

$response = curl_exec($curl);

curl_close($curl);

if (!empty($response)) {
    $response = json_decode($response);
    if (!empty($response)) {
        if (isset($response->unread_private_chat_messages)) {
            echo 'Unread Private Chat Messages : '.$response->unread_private_chat_messages;
        }
        
        if (isset($response->unread_group_messages)) {
            echo 'Unread Group Chat Messages : '.$response->unread_group_messages;
        }
        
        if (isset($response->unread_site_notifications)) {
            echo 'Unread Site Notifications : '.$response->unread_site_notifications;
        }
        
        if (isset($response->unresolved_complaints)) {
            echo 'Unsolved Complaints : '.$response->unresolved_complaints;
        }
        
        if (isset($response->pending_friend_requests)) {
            echo 'Pending Friend Requests : '.$response->pending_friend_requests;
        }
    }
}
?>