Search
Close this search box.

< / >

Agent APIs

Dialing

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?agent_id={{agent_id}}&api=dial&customer_phone={{customer_phone}}&customer_id={{customer_id}}&customer_name={{customer_name}}

Description:

This API allows dialing from your internal application without complex developments.

Benefit:

By using this API, you gain dialing convenience, integration with the internal application, automated dialing, efficiency in the calling process, and enhanced agent 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.
  • Replace {{agent_id}} with the agent’s extension number assigned in the wolkvox system.
  • Replace {{customer_phone}} with the customer’s phone number.
  • Replace {{customer_id}} with the customer’s identification number. This field is optional.
  • Replace {{customer_name}} with the customer’s name. This field is optional.
  • Use “wolkvox-token: {{token}}” in the HEADER, replacing {{token}} with the authorization token generated in your wolkvox operation.
  • Note 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: This API is compatible with both wolkvox Desktop Agent and web version.
     
     
REQUEST
NAME DESCRIPTION TYPE
token Code of the token generated in the wolkvox Manager application. INT
wolkvox_server Server nomenclature where your operation is located. This code is provided by support staff. INT
agent_id Agent extension number assigned in the wolkvox system. INT
customer_phone Customer phone number to dial. INT
customer_id Customer identification number. This field is optional. INT
customer_name Customer name. This field is optional. String
RESPONSE
NAME DESCRIPTION TYPE
code Indicates the response status code. String
error Provides detailed information about any errors that may have occurred 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 Contains the data or set of data obtained when consuming the API. In other words, it stores specific information related to the operation carried out through the API. JSON Object
conn_id Call identification code. String
Possible response codes

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "Dial 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