Search
Close this search box.

< / >

APIs

9. List activity codes

URL: https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=activity_codes

Description:

This API allows you to have information about the activity codes active in your operation.

Benefit:

It allows to have basic information such as: number or name of the activity code, description of the activity code, if it is established or not as a hit and/or rpc, if it is available for typing chats and to which group of activity codes it belongs.

How it works:

  • The consumption of this API is done by GET method.
  • 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.
  • In terms of time, to keep track of your operation you can make a consumption every 5 minutes of the information.
  • 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.

Request

NAME DESCRIPTION TYPE
api Type of report required String

Response

NAME DESCRIPTION TYPE
code_act Name or identification number of the activity code String
description_cod_act Description of the activity code String
hit Indicates if the activity code is registered as “hit”. (yes/no). String
rpc Indicates whether the activity code registers the call as “rpc”. (yes/no). String
chat Indicates whether the activity code can be used in the typing of chats String
type_code It shows which activity code group it belongs to. It returns the value “cod_act1” if it belongs to activity code group #1, and “cod_act2” if it belongs to activity code group #2. String
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=activity_codes',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "0",
    "error": null,
    "msg": " records were found",
    "data": [
        {
            "cod_act": " ",
            "description_cod_act": " ",
            "hit": " ",
            "rpc": " ",
            "chat": " ",
            "type_code": " "
        },
        {
            "cod_act": " ",
            "description_cod_act": " ",
            "hit": " ",
            "rpc": " ",
            "chat": " ",
            "type_code": " "
        }
    ]
}
				
			
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