Log In an Agent to All Queues

Logs in an agent to all queues or to the specified queues in bulk. The operation applies to the agent user of the access token, which must be obtained using a user token rather than a platform token.

Request URL

POST {base_url}/uc-cconfig/api/v1/queues/agents/login-all

Request parameters

Headers


Parameter	Required	Type	Description
Authorization	Yes	String	The access token used for authentication. Format: Bearer `{access_token}`.
x-tenant-code	Yes	String	The tenant name. Note: You can obtain tenant name using the Query Tenants interface.

Body parameters


Parameter	Required	Type	Description
queueExtensions	No	Array<String>	The extension numbers of the specified queues. If not specified, all queues are included.

Response parameters


Parameter	Type	Description
requestId	String	The unique ID of the request, which can be used to quickly locate the request.
code	String	The HTTP status code of the request. `200`: Request succeeded. Non-200 value: Request failed.
message	String	The status message of the request.
detailMessage	String	The detailed error information. When the request is successful, this parameter returns empty.
result	Object<Batch_Agent_Status_Result>	The batch operation result.

Batch_Agent_Status_Result


Parameter	Type	Description
successCount	Integer	The number of queues on which the operation succeeded.
failedCount	Integer	The number of queues on which the operation failed.
failures	Array<Failure_Item>	The list of failed items.

Failure_Item


Parameter	Type	Description
queueExtension	String	The extension number of the queue.
errorCode	String	The error code of the failure.
errorMessage	String	The description of the failure reason.

Example

Request example

POST /uc-cconfig/api/v1/queues/agents/login-all HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIxMDAwQGNvbG9ydGVzdDIiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX25hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiY2xpZW50X2V4dCI6eyJkZXNjcmlwdGlvbiI6IueuoeeQhuWQjuWPsFdlYuW6lOeUqCIsInBsYXRmb3JtIjoid2ViIn0sImV4cCI6MTc5MTkxMzkwNiwiaWF0IjoxNzkxODkyMzA2LCJqdGkiOiJiNGZiZTMxNS1jYWI4LTRiMWMtOTA3MC1lOWYyMTE2YTVhNDAiLCJjbGllbnRfaWQiOiJub3ZvLWFkbWluLXdlYiIsInNpZCI6IjRiMTBjNzhiLTk3MTktNDBiZS1iMTVkLWRkMTM2N2Q1YTcxOCIsInVzZXJfZXh0Ijp7InJvbGVJZHMiOlsxMDJdLCJwdWlkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJ0ZW5hbnRJZCI6MjA3OTUwNDIwNTMwOTE5NDI0MSwicGFyZW50VWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5NiwidGVuYW50Q29kZSI6ImNvbG9ydGVzdDIiLCJ0eXBlIjoiVF9VU0VSIiwidXNlcklkIjoyMDc5NzQ2OTE1Mzg4MDc2MDMzLCJlbWFpbCI6Imxlb0BzYW1wbGUuY29tIiwidXNlcm5hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJ1Y0lkIjozMDc2OTEzNjQ0ODkwODMyODk2fX0.cQ4A5Vq0eVKmzCDk7_-RpSugBUZkJzapsFbymhufUw5SCrNJLpGdQd9-t9brU4wBlP87ItJBV73i509h3ogn5nTGMGPF_uuHKcKgsHb7CDdRpx5FKlemiPxuixVzzfKYS68nUIDY3sTbEfUa78Wqbn5N_Wqj15uxJu_gbMjOCDkguwRo52ZAPIQhYt5Xku-9jZSU7MJl_oxuohSn6gEWDKIEZzlKQBTN7tvV_url1jSiEcKbkqqZcp0LtEolCkEbt01nIvaTqATEzeFb0PGog5MqnGD-rTWFvCXoCRBM4OCpmxvZTP5vva2Vf1MIYhUHwFqq9RipBxBkdagJuwp6Bw
Content-Type: application/json
x-tenant-code: jint
{
  "queueExtensions": [
    "9901"
  ]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "edcec1cb67b93865297924f4ed5af49f",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "successCount": 1,
    "failedCount": 0,
    "failures": []
  }
}