Sign In to Finesse

Use the User - Sign In to Finesse API to sign the agent in.

This example uses the following information:

  • Finesse server FQDN: finesse1.xyz.com

  • Agent name: John Smith

  • Agent ID: 1234

  • Agent password: 1001

  • Agent extension: 1001

  • requestId: xyz

Note

This example shows the URL field for a Unified CCE deployment. In a Unified CCX deployment, you must include the port number in the URL.

  1. Access Postman (Ctrl + Alt +P from the Mozilla Firefox browser) and enter the following string in the URL field: 

    https://finesse1.xyz.com/finesse/api/User/1234

  2. Enter the agent's ID (1234) and password (1001) in the two User Auth fields directly under the URL field.

  3. In the Content Type field, enter application/XML.

  4. In the area under Content Options, enter the following: 

    <User>
 <state>LOGIN</state>
 <extension>1001</extension>
</User>

  5. (Optional) To add the requestId:

    1. Click Headers.

    2. In the Name field, enter requestId, and in the Value field, enter xyz.

    3. Click Add/Change

  6. Click PUT.

    Postman returns the following response: 

    PUT on https://finesse1.xyz.com/finesse/api/User/1234
Status 202: Accepted

    Finesse returns a user notification, which you can view in Pidgin: 

    <Update>
    <data>
        <user>
            <dialogs>/finesse/api/User/1234/Dialogs</dialogs>
            <extension>1001</extension>
            <firstName>John</firstName>
            <lastName>Smith</lastName>
            <loginId>1234</loginId>
            <loginName>jsmith</loginName>
            <roles>
                <role>Agent</role>
            </roles>
            <pendingState></pendingState>
            <reasonCodeId>-1</reasonCodeId>
            <settings>
                <wrapUpOnIncoming></wrapUpOnIncoming>
                <wrapUpOnOutgoing></wrapUpOnOutgoing>
            <settings>
                <state>NOT_READY</state>
                <stateChangeTime>2014-05-27T00:33:44.836Z</stateChangeTime>
                <teamId>1</teamId>
                <teamName>Default</teamName>
                <uri>/finesse/api/User/1234</uri>
            </settings>
        </user>
    </data>
    <event>PUT</event>
    <requestId>xyz</requestId>
    <source>/finesse/api/User/1234</source>
</Update>

    The agent is now signed in and in NOT_READY state.