Fetch Login Details
    • Dark
      Light

    Fetch Login Details

    • Dark
      Light

    Article summary

    Overview

    This API allows the user to fetch 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

    FetchCredentials

    data

    «JSON Object»

    Response Parameters

    Value

    channel

    Salesforce

    topic

    User

    subtopic

    FetchCredentials

    message

    «JSON Object»

    Response 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

    Success

    Boolean

    The request status - whether response fetched succesfully.

    True

    ErrorMessage

    String

    The reason for a response error, if any.

    Null

    Sample Request

    {
        "channel": "Salesforce",
        "topic": "User",
        "subtopic": "FetchCredentials",
        "source": "myapp"
    }

    Sample Response

     {
        "channel": "Salesforce",
        "topic": "User",
        "subtopic": "FetchCredentials",
        "data": 
        {
            "Username": "1245456",
            "Password": "acq@123",
            "Extension": "5051",
            "ADFSUsername": "",
            "Success": true,
            "ErrorMessage": null
        }
    }


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.