URL:

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

Description:

This API allows muting the agent’s microphone.

Benefit:

By using this API, you gain remote control of agent microphones, operational automation, resource optimization, and improved user experience.

How it works?

• Consumption of this API is performed using the POST method.
• Replace {{wolkvox_server}} in the URL with the nomenclature of your operation on the server.
• Replace {{agent_id}} with the agent’s extension number assigned in the Wolkvox system.
• Use “wolkvox-token: {{token}}” in the HEADER, replacing {{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 next API consumption 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: If this API is consumed and the MUTE button in the agent’s application was active, it is deactivated, and vice versa.
• Note: This API is compatible with both wolkvox Desktop Agent and web version.