- DarkLight
Check Non-Voice Task State
- DarkLight
Overview
This API is used to check the state of a non-voice task. This is useful if you want to check, before processing a task, if a customer has already processed the same task.
Pre-requisite
The application registration must be completed.
Sequence Diagram

Message Structure
Request Parameters | Value |
|---|---|
channel | Salesforce |
topic | Call |
subtopic | CheckTaskState |
source | «Source application name» |
data | «JSON Object» |
Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
workid | String | Non-voice task identifier. | 12345 |
Response Parameters | Value |
|---|---|
channel | Salesforce |
topic | Call |
subtopic | CheckTaskState |
message | «JSON Object» |
Response Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
isClosed | Boolean | Indicates if the customer has closed the task. True if customer has closed; else false. | True |
workid | String | Non-voice task identifier. | 12345 |
Success | Boolean | Request status | True |
ErrorMessage | String | Error detail on why the request failed. | Null |
Sample Request
{
"channel": "Salesforce",
"topic": "Call",
"subtopic": "CheckTaskState",
"source": "myapp",
"data":
{
"workid": "12345"
}
}Sample Response
{ "channel": "Salesforce",
"topic": "Call",
"subtopic": "CheckTaskState",
"data":
{
"isClosed": true,
"workid": "12345",
"Success": true,
"ErrorMessage": null
}
}