fbpx
Search
Close this search box.
Search
Close this search box.

< / >

APIs Configuration

3. Creation of activity codes

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=create_cod_act

Description:

This API allows you to create, modify and update typecode listings from external applications to make this process simpler and more agile.

Benefit:

Simplifies the process of creating and modifying typing codes to synchronize, streamline and optimize typing processes.

How it works:

  • The consumption of this API is done by POST method.
  • In the json the parameters are added according to the operation or process to be performed.
  • To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
  • The wolkvox-token header must be used to make use of the authorization token.
  • 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.

REQUEST

REQUEST
NAME DESCRIPTION TYPE
type_code Type code String
cod_act The value of the created code String
description_cod_act The description of the created code String
hit Refers to the actual calls, if not parameterized the default value is inserted as no (only receive: ‘yes’, ‘no’) String
rpc Refers to the call answered by the contact, if not set the default value is inserted as no (only receive: ‘yes’, ‘no’) String
chat  Sets whether the activity code will also be configured for chat types (only receive: ‘yes’, ‘no’) String
studio  Sets whether the activity code will be available or not for the wolkvox Studio section. (Only accepts “yes” and “no”). String
voice  Sets whether the activity code will be available or not in voice channels. (Only accepts “yes” and “no”). String

RESPONSE

RESPONSE
NAME DESCRIPTION TYPE
code Response code int
error Error String
msg Description of the response String

Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=create_cod_act',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "type_code": "",
    "cod_act": "",
    "description_cod_act": "",
    "hit": "",
    "rpc": "",
    "chat": "",
    "studio": "",
    "voice": ""
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}',
    'Content-Type: text/plain'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": 201,
    "error": null,
    "msg": "Code successfully created"
}

				
			
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