URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?status={{status}}&api=change_status&agent_id={{agent_id}}

Description:

This API allows changing the agent’s state to the “Ready” state or an auxiliary state created in the wolkvox system of your operation.

Benefit:

By using this API, you achieve dynamic changes in the agent’s state, automation of state changes, integration with workflows, and operational efficiency.

How it works?

• The consumption of this API is done using the POST method.
• Replace {{wolkvox_server}} in the URL with the nomenclature of your operation on the server.
• You should replace {{status}} with the code of the state you want to assign to the agent. You can obtain the codes for auxiliary states in the “ID” column of the “Agent States” tab in the configuration of the wolkvox Manager application for your operation. For default states, you can use “ready” or “logout.”
• Replace {{agent_id}} with the agent’s extension number assigned in the wolkvox system.
• Use “wolkvox-token: {{token}}” in the HEADER and replace {{token}} with the authorization token generated in your wolkvox operation.
• Keep in mind that the same token cannot be consumed simultaneously, so you can schedule the consumption of the next API when the result of the previous one is successful.
• The agent APIs v2 require an authentication token for access; however, the use of this token does not affect the assigned consumption. It is important to note that all other restrictions and limits set for API consumption remain applicable when using the agent v2 APIs.
• Limit of records that can be downloaded per consumption: 60,000 records.
• Limit of records that can be uploaded per consumption: 10,000 records.
• Limit of days queried in dates: 31 days.
• Limit of result weight: 256 MB.
• API consumption time limit: 60 seconds.
• Concurrent consumption limit of a token: 2 simultaneous requests.
• Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.
• Note: This API is compatible with both wolkvox Desktop Agent and web version.