Grupo Chat

https://docs.grupochat.co
Admin
Grupo Chat is a customizable, real-time PHP chat room script that allows website owners to host...
Tokens:30,083
Snippets:439
Trust Score:6.2
Update:2 months ago
Show doc for...
Tokens:
Raw
### Enable and Start LiveKit Service

Source: https://docs.grupochat.co/deploy-livekit-on-your-server

Reloads the systemd daemon and starts the LiveKit service.

```bash
sudo systemctl daemon-reexec
sudo systemctl daemon-reload
sudo systemctl enable livekit
sudo systemctl start livekit
```

--------------------------------

### Install LiveKit Server

Source: https://docs.grupochat.co/deploy-livekit-on-your-server

Executes the official installation script to set up the LiveKit server binary.

```bash
curl -sSL https://get.livekit.io | bash
```

--------------------------------

### Install Swoole via PECL

Source: https://docs.grupochat.co/real-time-with-websocket-ajax

Downloads and installs the Swoole extension using the PHP Extension Community Library.

```bash
sudo pecl install swoole
```

--------------------------------

### Install PHP Dependencies

Source: https://docs.grupochat.co/real-time-with-websocket-ajax

Installs the necessary PHP development tools required for PECL extensions.

```bash
sudo apt install php-pear php-dev
```

--------------------------------

### Enable and Start WebSocket Service

Source: https://docs.grupochat.co/real-time-with-websocket-ajax

Commands to reload systemd and manage the WebSocket service lifecycle.

```bash
sudo systemctl daemon-reexec
sudo systemctl daemon-reload
sudo systemctl enable websocket.service
sudo systemctl start websocket.service
```

--------------------------------

### Configure Nginx for Subdirectory Integration

Source: https://docs.grupochat.co/nginx-windows-server

Use these location blocks when Grupo is installed in a specific subdirectory. Ensure this block is defined before the generic root location block.

```nginx
location /subfoldername/ {
               try_files $uri $uri/ /subfoldername/index.php?$args;
           }
location ~* /(subfoldername/assets)/(.+)\.(jpg|jpeg|png|gif|svg|flv|mp3|jfif|wav|mp4|ogg|pdf|webm|bmp|avif|webp|json|woff|woff2|ttf|eot|js|css|map|mov)$ {
             allow all;
       }
location ~* /(subfoldername/assets/files)/(.+)\.(jpg|jpeg|png|gif|svg|flv|mp3|jfif|wav|mp4|ogg|pdf|avif|webm|bmp|webp|mov)$ {
              allow all;
        }
location ~ /(subfoldername/fns|subfoldername/pages|subfoldername/include|subfoldername/layouts|subfoldername/assets)/(.+)\.[^\.]+$ {
           deny all;
       }
```

--------------------------------

### Update System Packages

Source: https://docs.grupochat.co/real-time-with-websocket-ajax

Updates the local package index and upgrades installed packages.

```bash
sudo apt update && sudo apt upgrade -y
```

--------------------------------

### Configure Nginx for Root Domain Integration

Source: https://docs.grupochat.co/nginx-windows-server

Use these location blocks when Grupo is installed at the root of your domain.

```nginx
location / {
                try_files $uri $uri/ /index.php?$args;
            }
            location ~ /(fns|pages|include|layouts) {
              deny all;
              return 404;
        }
location ~* /(assets)/(.+)\.(jpg|jpeg|png|gif|svg|flv|mp3|jfif|wav|mp4|ogg|pdf|avif|webm|bmp|webp|json|woff|woff2|ttf|eot|js|css|map|mov)$ {
              allow all;
        }
location ~* /(assets/files)/(.+)\.(jpg|jpeg|png|gif|svg|flv|mp3|jfif|wav|mp4|ogg|pdf|avif|webm|bmp|webp|mov)$ {
              allow all;
        }
location ~ /(fns|pages|include|layouts|assets)/(.+)\.[^\.]+$ {
            deny all;
        }
```

--------------------------------

### Create LiveKit Configuration Directory and File

Source: https://docs.grupochat.co/deploy-livekit-on-your-server

Prepares the configuration directory and opens the YAML file for editing.

```bash
mkdir /etc/livekit/
nano /etc/livekit/livekit.yaml
```

--------------------------------

### Create Systemd Service File

Source: https://docs.grupochat.co/deploy-livekit-on-your-server

Opens the systemd service file for editing to manage the LiveKit process.

```bash
sudo nano /etc/systemd/system/livekit.service
```

--------------------------------

### Create Systemd Service File

Source: https://docs.grupochat.co/real-time-with-websocket-ajax

Opens the systemd service configuration file for editing.

```bash
sudo nano /etc/systemd/system/websocket.service
```

--------------------------------

### Configure UFW Firewall

Source: https://docs.grupochat.co/deploy-livekit-on-your-server

Opens the necessary TCP and UDP ports for LiveKit traffic and reloads the firewall rules.

```bash
sudo ufw allow 7880/tcp
sudo ufw allow 7881/tcp
sudo ufw allow 7881/udp
sudo ufw reload
```

--------------------------------

### Systemd Service Definition

Source: https://docs.grupochat.co/deploy-livekit-on-your-server

The unit file configuration for running LiveKit as a background service.

```ini
[Unit]
Description=LiveKit Server
After=network.target

[Service]
Type=simple
ExecStart=/usr/local/bin/livekit-server --config /etc/livekit/**livekit.yaml**
Restart=on-failure
RestartSec=5s
User=root
LimitNOFILE=65536

[Install]
WantedBy=multi-user.target
```

--------------------------------

### POST /api_request/

Source: https://docs.grupochat.co/api-request-to-create-new-user

Creates a new user account in the Grupo Chatroom system.

```APIDOC
## POST /api_request/

### Description
Creates a new user account in the Grupo Chatroom system by sending user details and an API secret key.

### Method
POST

### Endpoint
https://yourgrupowebsiteaddress/api_request/

### Request Body
- **api_secret_key** (string) - Required - Your Grupo API Secret Key
- **add** (string) - Required - Must be set to 'site_users'
- **full_name** (string) - Required - The full name of the user
- **username** (string) - Required - The desired username
- **email_address** (string) - Required - The user's email address
- **password** (string) - Required - The user's password
- **avatarURL** (string) - Optional - URL for the user's avatar image
- **site_role** (string) - Optional - The role assigned to the user
- **custom_field_1** (string) - Optional - Custom field for user information

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the user account was created successfully
- **error_message** (string) - Error message if the request failed
```

--------------------------------

### LiveKit Configuration YAML

Source: https://docs.grupochat.co/deploy-livekit-on-your-server

Defines the server ports and authentication keys required for LiveKit operation.

```yaml
port: 7880

rtc:
  udp_port: 7881
  tcp_port: 7881
  use_external_ip: true

keys:
  my-api-key: ENTER_YOUR_32_CHARACTER_SECRET_HERE
```

--------------------------------

### Sync User Information in Sngine Settings

Source: https://docs.grupochat.co/sngine-integration

Insert this require statement into the settings function in includes/class-user.php to trigger user info updates on Grupo.

```php
require(ABSPATH . 'grupo_bridge/grupo_update_user_info.php');
```

--------------------------------

### Include User Update Bridge

Source: https://docs.grupochat.co/quickdate-integration

Insert this line into the QuickDate profile.php file to trigger user information synchronization with Grupo.

```php
require_once 'grupo_bridge/grupo_update_user_info.php';
```

--------------------------------

### Create New User via PHP

Source: https://docs.grupochat.co/api-request-to-create-new-user

Uses cURL to send a POST request to the API endpoint with user details and authentication credentials.

```php
<?php

$grupo_web_address = 'https://yourgrupowebsiteaddress'; 

$post_fields=[
  'api_secret_key' => 'Your_Grupo_API_Secret_Key',
  'add' => 'site_users',
  'full_name' => 'Full Name',
  'username' => 'username',
  'email_address' => 'user@emailaddress.com',
  'password' => 'password',
  'avatarURL' => 'https://avatar_image_url',
  'site_role' => '',
  'custom_field_1' => 'About Me',
];

$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 ($response->success) {
            echo "User Account Created";
        } else {
            echo $response->error_message;
        }
    }
}
?>
```

--------------------------------

### Verify Bridge Integration Context

Source: https://docs.grupochat.co/quickdate-integration

The required bridge file should be placed immediately following the user ID verification check within the save_general_setting function.

```php
if ($target_id == self::ActiveUser()->id) {
require_once 'grupo_bridge/grupo_update_user_info.php';
```

--------------------------------

### Include User Update Bridge

Source: https://docs.grupochat.co/wowonder-integration

Insert this line into WoWonder's user update files to trigger synchronization with Grupo.

```php
require_once 'grupo_bridge/grupo_update_user_info.php';
```

```php
echo json_encode($data);
require_once 'grupo_bridge/grupo_update_user_info.php';
```

--------------------------------

### POST /api_request/ (Create Group)

Source: https://docs.grupochat.co/category/api-requests/page/2

Creates a new group in the Grupo Chatroom.

```APIDOC
## POST /api_request/

### Description
Creates a new group in the Grupo Chatroom.

### Method
POST

### Endpoint
https://yourgrupowebsiteaddress/api_request/

### Parameters
#### Request Body
- **api_secret_key** (string) - Required - Your Grupo API Secret Key.
- **add** (string) - Required - Set to 'groups'.
- **group_name** (string) - Required - The name of the new group to be created.
```

--------------------------------

### POST /api_request/

Source: https://docs.grupochat.co/api-request-for-single-sign-on

Generates an auto-login URL for a user, optionally creating the account if it does not exist.

```APIDOC
## POST /api_request/

### Description
This endpoint generates an auto-login URL for a specified user. It supports creating a new user account if the provided email address does not exist in the system.

### Method
POST

### Endpoint
https://yourgrupowebsiteaddress/api_request/

### Request Body
- **api_secret_key** (string) - Required - The secret key for API authentication.
- **add** (string) - Required - Must be set to 'login_session'.
- **create_account** (string) - Required - Whether to create an account if it does not exist ('yes' or 'no').
- **email_address** (string) - Required - The email address of the user.
- **full_name** (string) - Optional - The full name of the user.
- **username** (string) - Optional - The username for the user.
- **password** (string) - Optional - The password for the user.
- **avatarURL** (string) - Optional - The URL for the user's profile image.
- **site_role** (string) - Optional - The site role ID for the user.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **auto_login_url** (string) - The generated URL to log the user in automatically.
```

--------------------------------

### POST /api_request/

Source: https://docs.grupochat.co/integrate-with-existing-website

This endpoint is used to perform SSO operations, including generating an auto-login URL and optionally creating a new user account if the specified account does not exist.

```APIDOC
## POST /api_request/

### Description
Generates an auto-login URL for a user. Optionally creates a new user account if the provided email does not exist in the system.

### Method
POST

### Endpoint
https://yourgrupowebsiteaddress/api_request/

### Request Body
- **api_secret_key** (string) - Required - The API secret key for authentication.
- **add** (string) - Required - Must be set to 'login_session'.
- **create_account** (string) - Optional - Whether to create an account if it doesn't exist ('yes'|'no').
- **email_address** (string) - Required - The email address of the user.
- **full_name** (string) - Optional - The full name of the user.
- **username** (string) - Optional - The username for the user.
- **password** (string) - Optional - The password for the user.
- **avatarURL** (string) - Optional - URL for the user profile image.
- **site_role** (string) - Optional - The site role ID for the user.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **auto_login_url** (string) - The URL used to log the user into the chat system.

#### Error Response
- **success** (boolean) - Set to false.
- **error_message** (string) - Description of the error encountered.
```

--------------------------------

### Sync User Account Deletion

Source: https://docs.grupochat.co/sngine-integration

Insert this require statement into the delete_user function in includes/class-user.php to remove the user from Grupo when their Sngine account is deleted.

```php
require(ABSPATH . 'grupo_bridge/grupo_delete_user.php');
```

--------------------------------

### Configure Apache Reverse Proxy

Source: https://docs.grupochat.co/real-time-with-websocket-ajax

Apache configuration snippet to enable WebSocket tunneling via mod_proxy_wstunnel.

```apache
<IfModule mod_proxy.c>
    <IfModule mod_proxy_wstunnel.c>
        ProxyPass "/ws/" "ws://127.0.0.1:9502/"
        ProxyPassReverse "/ws/" "ws://127.0.0.1:9502/"
    </IfModule>
</IfModule>
```

--------------------------------

### Include User Deletion Bridge

Source: https://docs.grupochat.co/wowonder-integration

Insert this line into the WoWonder account deletion file to remove users from Grupo when they delete their account.

```php
require_once 'grupo_bridge/grupo_delete_user.php';
```

--------------------------------

### POST /api_request/

Source: https://docs.grupochat.co/api-request-to-create-group

Creates a new group by sending a POST request to the API endpoint with the required group details.

```APIDOC
## POST /api_request/

### Description
Creates a new group on the platform.

### Method
POST

### Endpoint
https://yourgrupowebsiteaddress/api_request/

### Request Body
- **api_secret_key** (string) - Required - Your Grupo API Secret Key
- **add** (string) - Required - Must be set to 'groups'
- **group_name** (string) - Required - Name of the group
- **description** (string) - Optional - Description of the group
- **slug** (string) - Optional - URL slug for the group
- **group_category_id** (integer) - Optional - ID of the group category
- **secret_group** (string) - Optional - 'yes' or 'no'
- **unleavable** (string) - Optional - 'yes' or 'no'
- **pin_group** (string) - Optional - 'yes' or 'no'
- **password_protect** (string) - Optional - 'yes' or 'no'
- **password** (string) - Optional - Password for the group
- **group_icon_url** (string) - Optional - URL for the group icon
- **custom_field_10** (string) - Optional - Custom field value

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the group was created successfully
- **error_message** (string) - Error message if the request failed
```

--------------------------------

### Create a new group using PHP

Source: https://docs.grupochat.co/api-request-to-create-group

Uses cURL to send a POST request to the API endpoint with group configuration parameters.

```php
<?php

$grupo_web_address = 'https://yourgrupowebsiteaddress'; 

$post_fields=[
  'api_secret_key' => 'Your_Grupo_API_Secret_Key',
  'add' => 'groups',
  'group_name' => 'Group Name',
  'description' => 'Group Description',
  'slug' => 'group_slug',
  'group_category_id'=>'1',
  'secret_group' => 'no',
  'unleavable' => 'no',
  'pin_group' => 'no',
  'password_protect' => 'no',
  'password' => 'password',
  'group_icon_url' => 'https://group_icon_image_url',
  'custom_field_10' => 'Custom Field Value',
];

$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 ($response->success) {
            echo "Group Created Successfully.";
        } else {
            echo $response->error_message;
        }
    }
}
?>
```

--------------------------------

### Include User Update Bridge

Source: https://docs.grupochat.co/playtube-integration

Insert this line into the PlayTube user.php file to trigger user information updates in Grupo.

```php
require_once 'grupo_bridge/grupo_update_user_info.php';
```

```php
require_once 'grupo_bridge/grupo_update_user_info.php';
header("Content-type: application/json");
```

--------------------------------

### POST /api_request/

Source: https://docs.grupochat.co/api-request-to-add-user-to-a-group

Adds a user to a specified group using the Grupo API.

```APIDOC
## POST /api_request/

### Description
Adds a user to a group by providing the group identifier and the user's username or email address.

### Method
POST

### Endpoint
https://yourgrupowebsiteaddress/api_request/

### Request Body
- **api_secret_key** (string) - Required - Your Grupo API Secret Key
- **add** (string) - Required - Must be set to 'group_members'
- **group** (string) - Required - Group ID or Group Slug
- **user** (string) - Required - Username or email address of the user to add
- **group_role** (string) - Optional - Role to assign to the user

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful

#### Error Response
- **error_message** (string) - Description of the error if the operation failed
```

--------------------------------

### POST /api_request/

Source: https://docs.grupochat.co/api-request-to-update-user

Updates user information in the Grupo Chatroom system.

```APIDOC
## POST /api_request/

### Description
Updates user information including profile details and custom fields.

### Method
POST

### Endpoint
https://yourgrupowebsiteaddress/api_request/

### Request Body
- **api_secret_key** (string) - Required - Your Grupo API Secret Key
- **update** (string) - Required - Must be set to 'site_users'
- **user** (string) - Required - The username or email address of the user to update
- **full_name** (string) - Optional - The new full name
- **username** (string) - Optional - The new username
- **email_address** (string) - Optional - The new email address
- **password** (string) - Optional - The new password
- **avatarURL** (string) - Optional - URL for the user avatar
- **site_role** (string) - Optional - The user role
- **custom_field_1** (string) - Optional - Custom field data

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the update was successful
- **error_message** (string) - Error details if the request failed
```

--------------------------------

### POST /api_request/

Source: https://docs.grupochat.co/api-request-to-add-device-token-push-notifications

Registers a device token (Player ID or Subscriber ID) for a specific user to receive push notifications.

```APIDOC
## POST /api_request/

### Description
Registers a device token (Player ID or Subscriber ID) for a specific user to enable push notifications.

### Method
POST

### Endpoint
https://yourgrupowebsiteaddress/api_request/

### Request Body
- **api_secret_key** (string) - Required - Your Grupo API Secret Key
- **add** (string) - Required - Must be set to 'push_subscriber'
- **user** (string) - Required - The username or email address of the user
- **device_token** (string) - Required - The PlayerID or Subscriber ID to register

### Request Example
{
  "api_secret_key": "Your_Grupo_API_Secret_Key",
  "add": "push_subscriber",
  "user": "username/email_address",
  "device_token": "PlayerID/SID"
}
```
Tokens:
Raw