Users Groups

Introduction

Work with Users groups using this module. You can get all groups list for your application and set user group for your players. Learn more about working with User Groups in the Dashboard here.

Users Groups Available Methods

Users.GetGroupsList (get_group_list)

This method requires Project ID and Client Key

API Url:

https://cp.ocugine.pro/api/users/get_group_list/

Request POST Params:

Parameter Type Description
app_id (required) double Project ID
app_key (required) string Project Client Key

Response Example:

{
    "complete": true,
    "message": null,
    "data": {
        "list": [
            {
                "uid": -1,
                "project_id": 59,
                "group_name": "Default Group",
                "group_desc": "Default Ocugine Users Group",
                "conditions": [],
                "can_select": true,
                "auto_detect": true
            },
            {
                "uid": "33",
                "project_id": "59",
                "group_name": "Another Group",
                "group_desc": "Just another user group for application or game",
                "time": "1565450804",
                "conditions": [],
                "can_select": false,
                "auto_detect": true
            },
            {
                "uid": "49",
                "project_id": "59",
                "group_name": "VIP",
                "group_desc": "VIP users group",
                "time": "1568394920",
                "conditions": [],
                "can_select": false,
                "auto_detect": true
            },
            {
                "uid": "52",
                "project_id": "59",
                "group_name": "Demo",
                "group_desc": "Demo Group",
                "time": "1569294610",
                "conditions": [],
                "can_select": false,
                "auto_detect": true
            }
        ],
        "num": 3
    }
}

Users.GetGroupData (get_group_data)

This method requires Project ID and Client Key

API Url:

https://cp.ocugine.pro/api/users/get_group_data/

Request POST Params:

Parameter Type Description
app_id (required) double Project ID
app_key (required) string Project Client Key
group_id (required) double Group UID (-1 = default group)

Response Example:

{
    "complete": true,
    "message": null,
    "data": {
        "uid": "33",
        "project_id": "59",
        "group_name": "Another Group",
        "group_desc": "Just another user group for application or game",
        "time": "1565450804",
        "conditions": [],
        "can_select": false,
        "auto_detect": true
    }
}

Users.SetGroup (set_group)

This method requires Project ID and Client Key

API Url:

https://cp.ocugine.pro/api/users/set_group/

Request POST Params:

Parameter Type Description
app_id (required) double Project ID
app_key (required) string Project Client Key
profile_uid (required) double Profile UID (Application must be installed for this user)
group_id (required) double Group UID (-1 = default group)

Response Example:

{
    "complete": true,
    "message": "",
    "data": []
}