How can we help?
{{docApp.searchError}}
{{product.name}}
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Operation Information
- Application Reference:
com.hornbill.servicemanager - Scope:
Global - Class:
Application - Required Privilege Level:
user - Required Rights: Group H - executeSystemAPIs
Description
This operation returns details about customers recent requests. For use with chatbot integrations.
Request Parameters
The chatbotGetRecentRequests API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.
| Name | Type | Required | Description |
|---|---|---|---|
userId |
xs:string |
Yes | The chatbot session user ID |
requestType |
xs:string |
No | Comma separated list of request types to return |
requestStatus |
xs:string |
No | Comma separated list of request statuses to return |
requestServiceId |
xs:string |
No | Comma separated list of request service IDs to return |
requestCatalogId |
xs:string |
No | Comma separated list of request service IDs to return |
rowstart |
xs:integer |
No | The row to start from. Defaults to 0 |
limit |
xs:integer |
No | The number of requests to return. Defaults to 5 |
Response Parameters
| Name | Type | Description |
|---|---|---|
requestData |
xs:string |
This parameter returns the request data as a JSON object |
requestCount |
xs:integer |
This parameter returns a count of the requests returned |
error |
xs:string |
This parameter is set with validation errors. |
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.servicemanager","@method":"chatbotGetRecentRequests","params":{"userId":"xs:string","requestType":"xs:string","requestStatus":"xs:string","requestServiceId":"xs:string","requestCatalogId":"xs:string","rowstart":1,"limit":1}}'
package main
import (
"fmt"
apiLib "github.com/hornbill/goApiLib"
)
func main() {
hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
hornbillAPI.SetAPIKey("yourHornbillAPIKey")
hornbillAPI.SetJSONResponse(true)
hornbillAPI.SetParam("userId", "xs:string")
hornbillAPI.SetParam("requestType", "xs:string")
hornbillAPI.SetParam("requestStatus", "xs:string")
hornbillAPI.SetParam("requestServiceId", "xs:string")
hornbillAPI.SetParam("requestCatalogId", "xs:string")
hornbillAPI.SetParam("rowstart", "xs:integer")
hornbillAPI.SetParam("limit", "xs:integer")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.servicemanager", "chatbotGetRecentRequests")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager";
const payload = {
"@service": "apps/com.hornbill.servicemanager",
"@method": "chatbotGetRecentRequests",
"params": {
"userId": "xs:string",
"requestType": "xs:string",
"requestStatus": "xs:string",
"requestServiceId": "xs:string",
"requestCatalogId": "xs:string",
"rowstart": 1,
"limit": 1
}
};
fetch(endpoint, {
method: 'POST',
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
},
body: JSON.stringify(payload)
}).then(res => res.json())
.then(res => console.log(res));
const axios = require('axios');
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager";
const payload = {
"@service": "apps/com.hornbill.servicemanager",
"@method": "chatbotGetRecentRequests",
"params": {
"userId": "xs:string",
"requestType": "xs:string",
"requestStatus": "xs:string",
"requestServiceId": "xs:string",
"requestCatalogId": "xs:string",
"rowstart": 1,
"limit": 1
}
};
const axiosConfig = {
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
};
axios.post(endpoint, payload, axiosConfig)
.then((res) => {
console.log("RESPONSE RECEIVED: ", res);
})
.catch((err) => {
console.log("AXIOS ERROR: ", err);
})
$endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager";
$payload = (object) [
'@service' => 'apps/com.hornbill.servicemanager',
'@method' => 'chatbotGetRecentRequests',
'params' => (object) [
'userId' => 'xs:string',
'requestType' => 'xs:string',
'requestStatus' => 'xs:string',
'requestServiceId' => 'xs:string',
'requestCatalogId' => 'xs:string',
'rowstart' => 'xs:integer',
'limit' => 'xs:integer',
]
];
$headers = [
'Authorization: ESP-APIKEY yourHornbillAPIKey',
'Content-Type: application/json'
];
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $endpoint);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$resp = curl_exec($curl);
curl_close($curl);
echo $resp;
$Endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager"
$Body = @{
"@service" = "apps/com.hornbill.servicemanager"
"@method" = "chatbotGetRecentRequests"
params = @{
userId = "xs:string"
requestType = "xs:string"
requestStatus = "xs:string"
requestServiceId = "xs:string"
requestCatalogId = "xs:string"
rowstart = "xs:integer"
limit = "xs:integer"
}
}
$Header = @{
"Authorization" = "ESP-APIKEY yourHornbillAPIKey"
}
$Parameters = @{
Method = "POST"
Uri = $Endpoint
Headers = $Header
Body = ($Body | ConvertTo-Json)
ContentType = "application/json"
}
Invoke-RestMethod @Parameters
import requests
import json
endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.servicemanager",
"@method":"chatbotGetRecentRequests",
"params":{
"userId":"xs:string",
"requestType":"xs:string",
"requestStatus":"xs:string",
"requestServiceId":"xs:string",
"requestCatalogId":"xs:string",
"rowstart":"xs:integer",
"limit":"xs:integer",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document