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.
| Property | Data type | Description |
|---|
| resources | List<Resource> | A list of resource |
| moreDataAvailable | bool | A boolean indicates an excess of resources beyond the specified page limit​ |
| Property | Data type | Description |
|---|
| id | String | The ID of the resource |
| category | SIQResourceCategory | Category of the resource |
| title | String | Resource title (default value) |
| departmentId | String | Department ID with which the resource is associated |
| language | Language | Language details of the resource |
| creator | User | Creator details of the resource |
| modifier | User | Modifier details of the resource |
| createdTime | Long | The resource created in time |
| modifiedTime | Long | The resource modified time |
| publicUrl | String | The public URL of the resource |
| stats | Stats | The resource stats for the likes, dislikes, views, and operator used count. |
| content | String | The content of the article (HTML format) |
| ratedType | ArticleAction (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.
|
| Property | Data type | Description |
|---|
| id | String | The ID of the resource category |
| name | String | Name of the resource category |
| Property | Data type | Description |
|---|
| id | String | The ID of the language |
| code | String | ISO code of the language |
| Property | Data type | Description |
|---|
| id | String | The ID of the User |
| name | String | Name of the user |
| email | String | Email address of the user |
| displayName | String | The display name of the user |
| imageUrl | String | The display picture public URL of the user |
| Property | Data type | Description |
|---|
| liked | int | Resources liked count |
| disliked | int | Resources disliked count |
| used | int | Resources used by the operator count |
| viewed | int | Resource views count |
| Property | Data type | Description |
|---|
| id | String | The ID of the resource category |
| name | String | Name of the category |
| departmentId | String | Department ID with which the resource is associated |
| count | int | The number of resources found within this category |
| childrenCount | int | The number of sub-categories within this category |
| order | int | The order (ascending) of the category to be listed |
| parentCategoryId | String | 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. |
| resourceModifiedTime | long | The time of the last modified resource within this category |
| Property | Data type | Description |
|---|
| id | String | The ID of the department |
| name | String | Name of the department |