Finesse API call on a Standard License

[StephenP21]

Hi,

I want to use the following API call to log out a user (from a phone):

https://<FQDN>:8445/finesse/api/User/<id>

Does anyone know can I use this API call on a standard license to phones connected using FIPPA?

Thank you.

[Anthony Holloway · Accepted solution]

Standard aside, this isn't going to work for you, because you need to know the Agent's password.

If you do have the Agent's password, then you need to send a PUT request to UCCX that matches the following:

URL

https://{UCCX}:8445/finesse/api/User/{AGENTID}

HTTP Basic Auth

You must use the Agent's credentials.  If you try to use the UCCX Admin account, you'll get the following error:

<ApiErrors>
    <ApiError>
        <ErrorType>Invalid Authorization User Specified</ErrorType>
        <ErrorData>aholloway</ErrorData>
        <ErrorMessage>The user specified in the authentication credentials and the uri don't match</ErrorMessage>
    </ApiError>
</ApiErrors>

Raw Body

<User>
	<state>LOGOUT</state>
	<logoutAllMedia>true</logoutAllMedia>
</User>

This will in fact logout an Agent who is logged into FIPPA, and after a few seconds, their phone screen will show:

What you might want to do instead is, use the FIPPA Logout URL, which does not require you to know the Agent's password, but you do need to know the phone name where they're logged in at.

URL (you can just access this URL in your browser)

http://{UCCX}:8082/fippa/{PHONE}/logout

In your browser, you'll see something resembling the code for a login form, which is FIPPA bringing this now logged in Agent back to the login screen.

After a few seconds, their phone screen will show the FIPPA sign in screen again.

You cannot close the sign in screen, unless you then also look at using the IP Phone API, and send Key:Soft3 to the phone, which would press the Exit soft key.  That's a whole other technical discussion, but possible.