Insert task-type activity - crmvox

< / >

Insert

Insert task-type activity

URL:

https://{{wolkvox_server}}/server/API/v2/custom/insert.php

Description:

The following API configuration allows us to add task-type activities in the modules of our CRM.

How it works?

This API operates through a POST request, which requires the following fields for its proper functioning:

– In the request headers, the following is required:

Wolkvox-Token: {{token}}
Content-Type: application/json

– In the request body, the following is required:

operation
module
fields
status
name
priority
name_module
completion_date
remember
reminder_date
description
id_record
wolkvox_owner

REQUEST

KEY	DESCRIPTION	EXAMPLE
Wolkvox-Server	Server nomenclature of the operation.	wolkvox_server.crmvox.com
Wolkvox-Token	Token generated in the CRM module where you will consume the API.	token
operation	It is the name of the CRM operation.	“My-CRM-operation”
module	Used to indicate that an insertion in the CRM activity list is desired.	“module”:”wolkvox_activities”
type	Type of activity to create.	“type”: “task”
fields	It is the set of attributes or data parameters sent to the API to create a new task in the selected module. Each field corresponds to a specific piece of information about the task, such as its status, name, priority, completion date, etc. The API expects these fields in JSON format, where each field is represented as a key-value pair.	“fields”: { }
status	Activity status.	“status”: “created”
name	Activity name.	“name”: “Activity name”
priority	Activity priority. The value can be “high”, “normal”, or “low”.	“priority”: “low”
name_module	Name of the module where you want to add the activity.	“name_module”: “cases”
completion_date	Completion date of the activity in year-month-day hour-minute-second format.	“completion_date”: “2023-07-30 00:00:00”
remember	Indicates whether you want to activate (true) or deactivate (false) a reminder.	“remember”: true
reminder_date	Sets the date for when you want the reminder to be activated. The format is year-month-day hour-minute-second.	“reminder_date”: “2023-07-29 00:00:00”
description	Activity description.	“description”: “This is an activity description.”
id_record	Identification code of the selected module record where you want to add the activity.	“id_record”: “Id record”
wolkvox_owner	Owner user of the activity.	“wolkvox_owner”: “ADMIN_@mymodule”

REQUEST

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/custom/insert.php',
  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 =>'{
   "operation": "{{operation}}",
   "module": "wolkvox_activities",
   "type": "task",
   "fields": {
       "status": "created",
       "name": "{{name}}",
       "priority": "{{priority}}",
       "name_module": "{{module}}",
       "completion_date": "{{YYYYmmdd HHiiss}}",
       "remember": "{{remember}}",
       "reminder_date": "{{YYYYmmdd HHiiss}}",
       "description": "{{description}}",
       "id_record": "{{id record}}",
       "wolkvox_owner": "{{owner}}"
   }',
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token: {{token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location 'https://{{wolkvox_server}}/server/API/v2/custom/insert.php' \
--header 'Wolkvox-Token: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
   "operation": "{{operation}}",
   "module": "wolkvox_activities",
   "type": "task",
   "fields": {
       "status": "created",
       "name": "{{name}}",
       "priority": "{{priority}}",
       "name_module": "{{module}}",
       "completion_date": "{{YYYYmmdd HHiiss}}",
       "remember": "{{remember}}",
       "reminder_date": "{{YYYYmmdd HHiiss}}",
       "description": "{{description}}",
       "id_record": "{{id record}}",
       "wolkvox_owner": "{{owner}}"
   }
}
'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n   \"operation\": \"{{modulo}}\",\r\n   \"module\": \"wolkvox_activities\",\r\n   \"type\": \"task\",\r\n   \"fields\": {\r\n       \"status\": \"created\",\r\n       \"name\": \"{{name}}\",\r\n       \"priority\": \"{{priority}}\",\r\n       \"name_module\": \"{{name module}}\",\r\n       \"completion_date\": \"{{YYYmmdd HHiiss}}\",\r\n       \"remember\": \"{{remember}}\",\r\n       \"reminder_date\": \"{{YYYYmmdd HHiiss}}\",\r\n       \"description\": \"{{description}}\",\r\n       \"id_record\": \"{{id_record}}\",\r\n       \"wolkvox_owner\": \"{{wolkvox owner}}\"\r\n   }\r\n}\r\n");
Request request = new Request.Builder()
  .url("https://{{wolkvox_server}}/server/API/v2/custom/insert.php")
  .method("POST", body)
  .addHeader("Wolkvox-Token", "{{token}}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

				
					import requests
import json

url = "https://{{wolkvox_server}}/server/API/v2/custom/insert.php"

payload = json.dumps({
  "operation": "{{operation}}",
  "module": "wolkvox_activities",
  "type": "task",
  "fields": {
    "status": "created",
    "name": "{{name}}",
    "priority": "{{priority}}",
    "name_module": "{{module}}",
    "completion_date": "{{YYYYmmdd HHiiss}}",
    "remember": "{{remember}}",
    "reminder_date": "{{YYYYmmdd HHiiss}}",
    "description": "{{description}}",
    "id_record": "{{id_record}}",
    "wolkvox_owner": "{{wolkvox_owner}}"
  }
})
headers = {
  'Wolkvox-Token': '{{token}}',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

RESPONSE

				
					{
    "code": 200,
    "error": "null",
    "msg": "Succesfully create record",
    "data": {
        "wolkvox_id": " "
    }
}

Possible error codes

wolkvox
worldwide

COLOMBIA

Medellín +57 (604) 322 98 80
Bogotá +57 (601) 381 90 40
Cali +57 (602) 891 28 46
Barranquilla +57 (605) 316 10 34

ARGENTINA

Buenos Aires +54 (11) 5217 5933

BRAZIL

Goiânia +55 (62) 99328 6605

CHILE

Santiago de Chile +56 (2) 240 533 89

SPAIN

Madrid +34 (910) 601 691

UNITED STATES

Atlanta +1 (678) 496 7474

GUATEMALA

Ciudad de Guatemala +502 (2) 314 1344

MEXICO

Ciudad de México +52 (55) 8526 36 34

DOMINICAN REPUBLIC

Santo Domingo +1 (829) 249 69 68

PERU

Lima +51 (1) 644 91 39

|

Information security policy

|

Privacy policy and treatment of personal data

Copyright © 2022 MICROSYSLABS S.A.S. Cra 30 # 4A-45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia

OMNICHANNEL PLATFORM

CHATBOTS AND VOICEBOTS

wolkvox worldwide

COLOMBIA
Medellín +57 (4) 322 98 80
Bogotá +57 (1) 381 90 40
Cali +57 (2) 891 28 46
Barranquilla +57 (5) 316 10 34

ARGENTINA
Buenos Aires +54 (11) 5217 5933

SPAIN
Madrid +34 (910) 601 691

MEXICO
Ciudad de México +52 (55) 8526 36 34

BRASIL
Brasilia +55 (61) 9836 4127
São Paulo +55 (12) 9811 155 83

UNITED STATES
New York +1 (914) 373 71 36

DOMINICAN REPUBLIC
Santo Domingo +1 (829) 249 69 68

CHILE
Santiago de Chile +56 (2) 240 533 89

GUATEMALA
Ciudad de Guatemala +502 (2) 314 1344

PERU
Lima +51 (1) 644 91 39

Information security policy

Privacy policy and treatment of personal data

Copyright © 2022 MICROSYSLABS S.A.S.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia