LiveZilla Live Chat
1-Click Demo
EN  DE Bitte einloggen oder anmelden Hallo
Ein gro├čartiges Tool. Ein Unternehmen, welches online arbeitet sollte es sich nicht nehmen lassen mit...
Helmut Ehrhardt
Mehr Meinungen


LiveZilla API V2




KnowledgeBaseEntry
KnowledgeBaseEntry Object Format
KnowledgeBaseEntry is represented as JSON objects having the following keys:


JSON Key Type Required Read only Comment Example
IdstringNoNoUnique ID (32 chars)14t733d03f64db3b72af327d0d835ebd
TagsstringNoNoTags (comma separated)car,sharing,stations
ValuestringYesNoContent (HTML, URL or Filename)...
TitlestringYesNoTitleWhere to find car sharing stations?
LanguagesstringNoNoLanguages (comma-separated iso 2 letter code)de,fr
TypeintYesNoResource Type (0=Folder, 1=HTML/Text, 2=Link, 3=Operator File, 4=Customer File)0
ParentIdstringYesNoParent's Id (root = 1)ae33b353c9174c3f97628067f8104405
IsPublicintNoNoDefines if entry can be found in Knowledgebase1
FulltextSearchintNoNoDefines if fulltext (= content) search will be used1
ShortcutWordstringNoNoShortword for operator clientmyshortcut
GroupIdstringNoNoGroup ID (owner) (LiveZilla 6.1.1.0)support
OwnerIdstringNoNoOperator ID (owner) (LiveZilla 6.1.1.0)d351dc9
AllowBotAccessintYesNoDefines if entry will be used by Virtual Assistance1


KnowledgeBaseEntry Functions


List Knowledgebase Entries
Function
As of version 6.0.0.0


POST /api/v2/api.php p_knowledgebase_entries_list=1


Filters


Name POST Key Type Required Comment Example  
Show Privatep_show_privateboolNoPrivate (non-public) entries will be returned.1
Idp_idstringNoWill return the entry matching the given Id.14t733d03f64db3b72af327d0d835ebd
Limitp_limitintNoMaximum number of tickets to return.100
Offsetp_offsetintNoIndex where to start returning records (requires Limit parameter).101
Parent Idp_parent_idstringNoAll child nodes of parent will be returned.14t733d03f64db3b72af327d0d835ebd


CURL Example


curl {yourdomain}{livezilla_folder}/api/v2/api.php
-d {authenthication}
-d p_knowledgebase_entries_list=1 -X POST

Response


200 Ok: {
    "KnowledgeBaseEntries": [
        {
            "KnowledgeBaseEntry": {
                "Id": "14t733d03f64db3b72af327d0d835ebd",
                "Tags": "car,sharing,stations",
                "Value": "...",
                "Title": "Where to find car sharing stations?",
                "ParentId": "ae33b353c9174c3f97628067f8104405",
                "Type": 1,
                "OwnerId": null,
                "GroupId": "",
                "Languages": null,
                "IsPublic": 1,
                "FulltextSearch": 1,
                "ShortcutWord": "csstations",
                "AllowBotAccess": 1
            }
        }
    ]
}

Error Codes


                            403 Forbidden: Invalid or no user authentication data sent (see General API Authentication)
400 Bad Data: Invalid or missing POST parameters (see required fields/filters and data types)
                        



Create Knowledgebase Entry
Function
As of version 6.0.0.0


POST /api/v2/api.php p_knowledgebase_entry_create=1


Filters


Name POST Key Type Required Comment Example  


CURL Example


curl {yourdomain}{livezilla_folder}/api/v2/api.php
-d {authenthication}
-d p_knowledgebase_entry_create=1
-d p_data={ "KnowledgeBaseEntry": { "Id": "14t733d03f64db3b72af327d0d835ebd", "Tags": "car,sharing,stations", "Value": "...", "Title": "Where to find car sharing stations?", "ParentId": "ae33b353c9174c3f97628067f8104405", "Type": 1, "OwnerId": null, "GroupId": "", "Languages": null, "IsPublic": 1, "FulltextSearch": 1, "ShortcutWord": "csstations", "AllowBotAccess": 1 } } -X POST

Response


200 Ok: {
    "KnowledgeBaseEntry": {
        "Id": "14t733d03f64db3b72af327d0d835ebd",
        "Tags": "car,sharing,stations",
        "Value": "...",
        "Title": "Where to find car sharing stations?",
        "ParentId": "ae33b353c9174c3f97628067f8104405",
        "Type": 1,
        "OwnerId": null,
        "GroupId": "",
        "Languages": null,
        "IsPublic": 1,
        "FulltextSearch": 1,
        "ShortcutWord": "csstations",
        "AllowBotAccess": 1
    }
}

Error Codes


                            403 Forbidden: Invalid or no user authentication data sent (see General API Authentication)
400 Bad Data: Invalid or missing POST parameters (see required fields/filters and data types)
                        





Something missing?


If you find anything missing please let us know and we will add the missing structures right away. Thanks.