Knowledge Base

In SalesIQ, the knowledge base is a collection of resources (articles & FAQs) to offer self-service to your customers. With the Mobilisten SDK, you can provide these resources in your mobile app for users for self-service support. The knowledge base APIs allow performing resource-related actions like opening a resource, getting the resource list, categories list, controlling the visibility, and more. 

Note:

  • Knowledge Base APIs are supported from version 4.0.0.
  • Only articles, their categories, and sub-categories are supported. 
  • Currently, the FAQs are not supported. 

Result class contains the below properties

PropertyData typeDescription
resourcesList<Resource>A list of resource
moreDataAvailableboolA boolean indicates an excess of resources beyond the specified page limit​

Resource class contains the below properties

PropertyData typeDescription
idStringThe ID of the resource
categorySIQResourceCategoryCategory of the resource
titleStringResource title (default value)
departmentIdStringDepartment ID with which the resource is associated
languageLanguageLanguage details of the resource
creatorUser Creator details of the resource
modifierUser Modifier details of the resource
createdTimeLongThe resource created in time
modifiedTimeLongThe resource modified time
publicUrlStringThe public URL of the resource
statsStats The resource stats for the likes, dislikes, views, and operator used count.
contentStringThe content of the article (HTML format)
ratedTypeArticleAction (String)

The article has been liked or disliked by the current visitor 

  • liked - The resource is liked by the visitor.
  • disliked - The resource is disliked by the visitor.

SIQResourceCategory

PropertyData typeDescription
idStringThe ID of the resource category
nameStringName of the resource category

Language

PropertyData typeDescription
idStringThe ID of the language
codeStringISO code of the language

User

PropertyData typeDescription
idStringThe ID of the User
nameStringName of the user
emailStringEmail address of the user
displayNameStringThe display name of the user
imageUrlStringThe display picture public URL of the user

Stats

PropertyData typeDescription
likedintResources liked count
dislikedintResources disliked count
usedintResources used by the operator count
viewedintResource views count

ResourceCategory class contains the below properties

PropertyData typeDescription
idStringThe ID of the resource category
nameStringName of the category
departmentIdStringDepartment ID with which the resource is associated
countintThe number of resources found within this category
childrenCountintThe number of sub-categories within this category
orderintThe order (ascending) of the category to be listed
parentCategoryIdString

The ID of the parent resource category

Note: This ID will be available only for sub-categories, and it'll be null for category always.

resourceModifiedTimelongThe time of the last modified resource within this category

ResourceDepartment class contains the below properties

PropertyData typeDescription
idStringThe ID of the department
nameStringName of the department