.png?sv=2022-11-02&spr=https&st=2025-12-29T07%3A22%3A06Z&se=2025-12-29T07%3A32%3A06Z&sr=c&sp=r&sig=opAG3V2WQyIgGgdwl%2FDZmqLFqm9y1%2BoNza8W9Tb1I0Q%3D){kind=logo}
Save Login Details
- DarkLight
Save Login Details
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This API allows the user to save the CTI credentials saved in Salesforce.
Pre-requisite
The application registration must be completed.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | Salesforce |
topic | User |
subtopic | SaveCredentials |
source | «Source Application Name» |
data | «JSON Object» |
Request Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
Username | String | The CTI username stored in Salesforce. | 123456 |
Password | String | The CTI password for the above user stored in Salesforce. | acq@123 |
Extension | String | The Agent extension stored in Salesforce. | 5051 |
ADFSUsername | String | NA | NA |
Response Parameters | Value |
|---|---|
channel | Salesforce |
topic | User |
subtopic | SaveCredentials |
message | «JSON Object» |
Response Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
Success | Boolean | The request status - whether response saved successfully. | True |
ErrorMessage | String | The reason for a response error, if any. | Null |
Sample Request
{
"channel": "Salesforce",
"topic": "User",
"subtopic": "SaveCredentials",
"source": "myapp",
"data":
{
"Username": "1245456",
"Password": "acq@123",
"Extension": "5051",
"ADFSUsername": ""
}
}Sample Response
{ "channel": "Salesforce",
"topic": "User",
"subtopic": "SaveCredentials",
"data":
{
"Success": true,
"ErrorMessage": null
}
}Was this article helpful?