URL:

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

Description:

This API allows putting the agent’s call on hold.

Benefit:

Using this API provides efficient call management, greater control over calls, time optimization, and an enhanced customer experience.

How it works?

• The consumption of this API is done through the POST method.
• Replace {{wolkvox_server}} in the URL with the nomenclature of your operation on the server.
• You should replace {{agent_id}} with the extension number assigned to the agent in the wolkvox system.
• Use ‘wolkvox-token: {{token}}’ in the HEADER, replacing {{token}} with the authorization token generated in your wolkvox operation.
• Please note that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed 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 call was on hold in the agent’s application, the hold is deactivated, and vice versa.
• Note: This API is compatible with both wolkvox Desktop Agent and web version.