Save Custom Variables

Overview

This method is used to save custom variables against a call. The variables sent in this API should have a corresponding mapping in Salesforce Admin rules (Call Log section / URL Invoke Section). These values will not be updated immediately as in “Update Object” request but are updated during the corresponding event configuration in Salesforce admin rules.

Pre-requisite

The Agent must be on an active call.

Sequence Diagram

Message Structure

Data Parameters

Response Data Parameters

Sample Request

{
    "channel": "Salesforce",
    "topic": "Call",
    "subtopic": "SaveCustomVariables",
    "source": "myapp",
    "data": 
    {
        "callId": "12345",
        "params": 
        {
            "variable1": "Value 1",
            "variable2": "Value 2",
            "variable3": "Value 3"
        }
    }
}

Sample Response

{
    "channel": "Salesforce",
    "topic": "Call",
    "subtopic": "SaveCustomVariables",
    "data": 
        {
        "callId": "12345",
        "params": 
        {
            "variable1": "Value 1",
            "variable2": "Value 2",
            "variable3": "Value 3"
        },
        "Success": true,
        "ErrorMessage": null
    }
}