Support

Introduction

Work with Support System using Ocugine Direct API or available SDKs. Work with categories, topics and messages inside your project. Learn more about working with Support System in the Dashboard here.

Support System Available Methods

Users.GetSupportCategories (get_support_categories)

This method requires Project ID and Client Key

API Url:

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

Request POST Params:

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

Response Example:

{
    "complete": true,
    "message": "",
    "data": {
        "list": [
            {
                "uid": "1",
                "project_id": "59",
                "name": "General Questions",
                "desc": "Here you can ask questions on a general topic.",
                "closed": "1",
                "sorting": "-4",
                "time": "1568549890",
                "topics_num": 0
            },
            {
                "uid": "12",
                "project_id": "59",
                "name": "Bugs",
                "desc": "In this category you can report bugs found.",
                "closed": "0",
                "sorting": "-3",
                "time": "1568149497",
                "topics_num": 2
            }
        ]
    }
}

Users.GetSupportTopics (get_support_topics)

This method requires Project ID and Client Key

API Url:

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

Request POST Params:

Parameter Type Description
app_id (required) double Project ID
app_key (required) string Project Client Key
category_id (required) double Category UID
search string Search by topic name / description
page double Page index (pagination)

Response Example:

{
    "complete": true,
    "message": "",
    "data": {
        "list": [
            {
                "uid": "3",
                "profile_uid": "17",
                "category_id": "12",
                "project_id": "59",
                "creation_time": "1568941922",
                "last_edit_time": "1568943730",
                "title": "Test 2",
                "is_closed": "0",
                "body": "Change Topic content",
                "messages": 3
            },
            {
                "uid": "1",
                "profile_uid": "17",
                "category_id": "12",
                "project_id": "59",
                "creation_time": "1568549944",
                "last_edit_time": "1568555782",
                "title": "Topic Test",
                "is_closed": "0",
                "body": "Swordfish zebra trout giant gourami. Pilchard Cherubfish king of herring North Pacific daggertooth ruffe ling cod; turkeyfish Mexican golden trout lake trout herring smelt. Lemon sole burma danio pikeperch suckermouth armored catfish deepwater flathead, sea bass bigmouth buffalo, \"cutlassfish dojo loach southern sandfish betta cornetfish chimaera triggerfish channel bass galjoen fish.\" Regal whiptail catfish. Dragonfish: coelacanth Reedfish panga slipmouth splitfin zebra turkeyfish ghost pipefish mullet ling cod duckbill armoured catfish. Tidewater goby, Ragfish loosejaw arrowtooth eel dragonfish ghost fish eagle ray. Zander inconnu longnose sucker deepwater stingray daggertooth pike conger, northern pearleye, kokanee halibut lined sole. Peladillo, sabertooth--bobtail snipe eel squeaker threadtail skilfish jewfish riffle dace pilot fish jewel tetra, African glass catfish. Brown trout. Tadpole fish duckbilled barracudina cepalin shark toadfish prowfish, slickhead, California halibut, woody sculpin Australian herring, brotula, ground shark Moorish idol greeneye parrotfish barbeled dragonfish smalleye squaretail. Wrymouth Molly Miller hagfish remora pompano dolphinfish cutlassfish nurseryfish humuhumunukunukuapua'a porcupinefish dealfish. Airsac catfish Australian grayling dealfish bull shark trevally Lost River sucker, flagfin Reedfish gulf menhaden vimba lemon shark morwong.\r\n\r\nTidewater goby mail-cheeked fish Rasbora duckbilled barracudina, zingel alewife squaretail banjo catfish snakehead snake mackerel olive flounder climbing gourami longfin dragonfish codlet. Hammerjaw amur pike parasitic catfish anchovy: Devario, pearlfish banjo catfish. Livebearer sandroller wolf-herring vimba anglerfish pomfret flathead whale shark.\" Bat ray spadefish squirrelfish ocean sunfish.",
                "messages": 2
            }
        ]
    }
}

Users.GetSupportMessages (get_support_messages)

This method requires Project ID and Client Key

API Url:

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

Request POST Params:

Parameter Type Description
app_id (required) double Project ID
app_key (required) string Project Client Key
topic_id (required) double Topic UID
search string Search by message body
page double Page index (pagination)

Response Example:

{
    "complete": true,
    "message": "",
    "data": {
        "list": [
            {
                "uid": "61",
                "project_id": "59",
                "category_id": "12",
                "topic_id": "3",
                "message": "asdsad",
                "time": "1569292902",
                "profile_uid": "17"
            },
            {
                "uid": "5",
                "project_id": "59",
                "category_id": "12",
                "topic_id": "3",
                "message": "Test Messaging",
                "time": "1568944050",
                "profile_uid": "17"
            },
            {
                "uid": "4",
                "project_id": "59",
                "category_id": "12",
                "topic_id": "3",
                "message": "sadasd",
                "time": "1568943744",
                "profile_uid": "17"
            }
        ]
    }
}

Users.CreateTopic (create_topic)

This method requires Access_Token, Project ID and Client Key

API Url:

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

Request POST Params:

Parameter Type Description
app_id (required) double Project ID
app_key (required) string Project Client Key
access_token (required) string Access Token of the User, who posted this topic
category_uid (required) double Category UID
name string Topic Name
body string Topic Body

Response Example:

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

Users.UpdateTopic (update_topic)

This method requires Access_Token, Project ID and Client Key

API Url:

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

Request POST Params:

Parameter Type Description
app_id (required) double Project ID
app_key (required) string Project Client Key
access_token (required) string Access Token of the User, who posted this topic
topic_uid (required) double Topic UID for Update
category_uid (required) double Category UID
name string Topic Name
body string Topic Body

Response Example:

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

Users.CloseTopic (close_topic)

This method requires Access_Token, Project ID and Client Key

API Url:

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

Request POST Params:

Parameter Type Description
app_id (required) double Project ID
app_key (required) string Project Client Key
access_token (required) string Access Token of the User, who posted this topic
topic_uid (required) double Topic UID to Close

Response Example:

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

Users.SendMessageToTopic (send_support_message)

This method requires Access_Token, Project ID and Client Key

API Url:

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

Request POST Params:

Parameter Type Description
app_id (required) double Project ID
app_key (required) string Project Client Key
access_token (required) string Access Token of the User, who send message to topic
topic_uid (required) double Topic UID to write message
message (required) string Message text

Response Example:

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