Search
Close this search box.

< / >

Agent APIs

Disposition

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?agent_id={{agent_id}}&api=type&cod_act={{cod_act}}&cod_act_2={{cod_act_2}}&comments={{comments}}

Description:

This API allows the agent to categorize or disposition the call from within their internal application without complex developments.

Benefit:

By using this API, you gain a quick and straightforward way to categorize, integrate without complex developments, and automate the call disposition.

How it works?

  • This API is consumed using the POST method.
  • Replace {{wolkvox_server}} in the URL with the nomenclature of your operation on the server.
  • Use “wolkvox-token: {{token}}” in the HEADER, replacing {{token}} with the authorization token generated in your wolkvox operation.
  • Replace {{cod_act}} with the disposition code to use from the group of activity codes #1 created in your operation. Disposition codes are created from the wolkvox Manager application in the left sidebar by selecting the “Activity codes” tab and choosing “cod_act1” or “cod_act2”. Activity codes can also be created using the API.
  • Replace {{cod_act_2}} with the disposition code to use from the group of activity codes #2 created in your operation. It is essential to fill in both disposition code fields without leaving the field for disposition code #2 empty. Disposition codes are created from the wolkvox Manager application in the left sidebar by selecting the “Activity codes” tab and choosing “cod_act1” or “cod_act2”. Activity codes can also be created using the API.
  • Replace {{comments}} with the agent’s comment to be assigned to the call disposition.
  • Please note 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.
     
     

REQUEST
NAME DESCRIPTION TYPE
token Token code generated in the wolkvox Manager application. INT
wolkvox_server Server nomenclature where your operation is located. This code is provided by support personnel. INT
agent_id Agent extension number assigned in the wolkvox system. INT
cod_act Disposition code to use from the group of activity codes #1 created in your operation. String
cod_act_2 Disposition code to use from the group of activity codes #2 created in your operation. String
comments Agent comment to assign to the call disposition. String
RESPONSE
NAME DESCRIPTION TYPE
code Indicates the status code of the response. String
error Provides detailed information about any errors that may occur during the API execution. The value “null” indicates that no errors occurred, and the API execution was successful. String
msg It is an informative message that describes the response. String
data It contains the data or set of data obtained when consuming the API. In other words, it stores specific information related to the operation performed through the API. JSON Object
conn_id Call identification code. String
Possible response codes

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "Type has been successful",
    "data": {
     "conn_id": ""
    }
}
				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data