.png?sv=2022-11-02&spr=https&st=2025-12-29T15%3A36%3A34Z&se=2025-12-29T15%3A46%3A34Z&sr=c&sp=r&sig=ftvNhyRDbIFqTBRX37lFgPPY11OYszanwMtU0I%2BUWCw%3D){kind=logo}
Remove Custom Variables
- DarkLight
Remove Custom Variables
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This method is used to remove custom variables saved against a call.
Pre-requisite
The Agent must be on an active call.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | Salesforce |
topic | Call |
subtopic | RemoveCustomVariables |
source | «Source application name» |
data | «JSON Object» |
Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
callid | String | Call ID for which you want to remove variables | 12345 |
params | JSON Object | Custom variables to be removed. |
Response Parameters | Value |
|---|---|
channel | Salesforce |
topic | Call |
subtopic | RemoveCustomVariables |
source | «JSON Object» |
Response Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
callid | String | Call ID for which you want to remove variables | 12345 |
params | JSON Object | Custom variables to be removed. | |
Success | Boolean | Indicates if the custom variables are removed. | True |
ErrorMessage | String | The error message is the response is a failure |
Sample Request
{
"channel": "Salesforce",
"topic": "Call",
"subtopic": "RemoveCustomVariables",
"source": "myapp",
"data":
{
"callId": "12345",
"params":
[
"variable3"
]
}
}Sample Response
"channel": "Salesforce",
"topic": "Call",
"subtopic": "RemoveCustomVariables",
"data":
{
"callId": "12345",
"params":
[
"variable3"
],
"Success": true,
"ErrorMessage": null
}Was this article helpful?