3CX v20 REST API - Changing logged in / out for queue

[hdservices]

Hi there,

We are using 3CX version 20 and are using the new REST API which is outstanding in all the options that it exposes in comparison to previous versions.

Within the 3CX Webserver, we are able to go to Panels (switchboard) and select a queue and see which users are member of it, and which one are logged into the queue.

We are able to add / remove people from the queue by using the REST API. Yet we can't find logging in or logging out from the queue.

When searching online we found a topic on this forum which describes how to change this on an older 3CX version, by changing a DNProperty of a user with the property name called LOGGED_IN_QUEUE.

https://www.3cx.com/community/threads/log-in-and-out-from-individual-queues-with-3cx-api.57826/

I tried to find this DNProperty in 3CX Version 20 but without success, I tried adding the property to a user, yet no succes either.

When using the GET /Users(id) api call, we can find the 'QueueStatus' but this seems an overal status. Neither can we change this value when we use the PATCH /Users(id).

Is there anyway we are able to log in / out a user from a queue?

 

[Evolute IT]

Nope no way yet. Gotta use the Panel view.

 

[hdservices]

Is there any reason this is not implemented within the API, or any prospect when this will be implemented?

 

[Evolute IT]

Is there any reason this is not implemented within the API, or any prospect when this will be implemented?

No and no.

 

[OlegOLP]

Is there anyway we are able to log in / out a user from a queue?

There are a couple of methods in our product that will help you https://creomate.com/3cx-api-documentation

Set 3CX extension queue status
https://{{3CXFQDN}}/webapi/{{AccessKey}}/ext.queue.set?num=102&queue=802&log=off/on

 

[hdservices]

No and no.

Is there any reason this feature was removed? Because following the earlier posted link, in 2018 this feature was still available through DN Properties...

 

[Evolute IT]

Is there any reason this feature was removed? Because following the earlier posted link, in 2018 this feature was still available through DN Properties...

I'm not 3CX....

 

[syadmins]

We found the way how to trigger login/logout from the queues using the XAPI API and PATCH method. The XAPI documentation doesn't mention that like many other API functions also missing from there.

Simply trigger a PATCH method to the endpoint Users and ensure you specify the USERID

Endpoint:
https://your3cxfqdn/xapi/v1/Users(USERID)

Login the user:

{
"QueueStatus":"LoggedIn"
}

Logout the user:

{
"QueueStatus":"LoggedOut"
}

 

[fxbastler]

The XAPI documentation doesn't mention that like many other API functions also missing from there.

I think it's there since 3CX v20 u4 in 12/2024 (but yes: was missing before in u3).
Now in 3CX v20 u7 b1080 swagger.yaml in line 19968 for Users(), line 22047 for schema Pbx.User, line 22251 for QueueStatus, line 31225 for schema Pbx.QueueStatusType with LoggedIn and LoggedOut.