https://{{crm_server}}/server/API/v2/custom/insert.php
La siguiente configuración de la API nos permite agregar actividades de tipo reunión en los módulos de nuestro CRM.
Esta API funciona a través de un cuerpo de tipo “raw” y una petición en POST, la cual requiere para su correcto funcionamiento los siguientes campos:
– En las cabeceras de la petición se requiere:
– En el cuerpo de la petición se requiere:
La URL de las APIs contiene un marcador de posición {{crm_server}} que debe ser sustituido por el servidor específico donde se encuentra la operación del cliente.
Servidores disponibles
Actualmente, los servidores disponibles son:
¿Cómo determinar el servidor del CRM?
Aviso importante: Actualización de rutas de acceso
A partir del 1 de septiembre de 2024, se implementarán nuevas URLs para acceder a la plataforma de wolkvox CRM. Las URLs actuales coexistirán con las nuevas hasta el 30 de noviembre de 2024, fecha en la cual serán deshabilitadas.
Nuevas URLs:
De “https://sv0001.crmvox.com” a “https://crm0001.wolkvox.com“
De “https://sv0000.crmvox.com” a “https://crm0000.wolkvox.com“
Por favor, asegúrate de actualizar tus integraciones y automatizaciones antes del 30 de noviembre de 2024 para evitar interrupciones en el servicio.
KEY | DESCRIPCIÓN | EJEMPLO |
---|---|---|
Wolkvox-Server | Nomenclatura del servidor de la operación. | wolkvox_server.crmvox.com |
Wolkvox-Token | Token generado en el módulo de CRM en donde vas a consumir la API. | token |
operation | Es el nombre de la operación del CRM. | “My-CRM-operation” |
module | Se utiliza para indicar que se desea hacer una inserción en la lista de actividades del CRM. | “module”:”wolkvox_activities” |
type | Tipo de actividad a crear. | “type”: “task” |
fields | Es el conjunto de atributos o parámetros de datos que se envían a la API para crear una nueva tarea en el módulo seleccionado. Cada campo corresponde a una pieza específica de información sobre la tarea, como su estado, nombre, prioridad, fecha de finalización, etc. La API espera que estos campos estén en formato JSON, donde cada campo se representa como un par clave-valor. | “fields”: { } |
status | Estado de la actividad. | “status”: “created” |
name | Nombre de la actividad. | “name”: “Nombre de la actividad” |
priority | Prioridad de la actividad. El valor puede ser “high” para alta, “normal” para normal o “low” para baja. | “priority”: “low” |
name_module | Nombre del módulo donde deseas agregar la actividad. | “name_module”: “cases” |
completion_date | Fecha de finalización de la actividad con formato de año-mes-día hora-minutos-segundos. | “completion_date”: “2023-07-30 00:00:00” |
remember | Indica si deseas activar (true) o no (false) un recordatorio. | “remember”: true |
reminder_date | Establece la fecha para cuando desees que se active el recordatorio. El formato es año-mes-día hora-minutos-segundos. | “reminder_date”: “2023-07-29 00:00:00” |
description | Descripción de la actividad. | “description”: “Esto es una descripción de la actividad” |
id_record | Código de identificación del registro del módulo seleccionado donde deseas añadir la actividad. | “id_record”: “código de id” |
location | Lugar donde se realizará la reunión. | “location”:”Mi enlace de reunión” |
start_date | Fecha de inicio de la reunión. | “start_date”: “2023-07-26 00:00:00” |
wolkvox_owner | Usuario dueño de la actividad. | “wolkvox_owner”: “ADMIN_@mimodulo” |
participants | Participantes que deseas asignar a la reunión. | “participants”:{
“type”:”participant”,
“value”:[“usuario 1”, “usuario 2”, “usuario 3”]
} |
$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": "meet",
"fields":{
"status":"created",
"name": "{{name}}",
"priority": "{{priority}}",
"name_module": "{{module}}",
"completion_date": "{{YYYmmaa HHiiss}}",
"remember": {{remember}},
"reminder_date": "{{YYYYmmaa HHiiss}}",
"description": "{{description}}",
"id_record": "{{id record}}",
"location":"{{location}}",
"start_date": "{{YYYYmmaa HHiiss}}",
"wolkvox_owner":"{{user}}",
"participants":{
"type":"participant",
"value":["{{user1}}", "{{user2}}", "{{user3}}"]
}
}
}',
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": "meet",
"fields":{
"status":"created",
"name": "{{name}}",
"priority": "{{priority}}",
"name_module": "{{module}}",
"completion_date": "{{YYYYmmdd HHiiss}}",
"remember": true,
"reminder_date": "{{YYYYmmdd HHiiss}}",
"description": "{{description}}",
"id_record": "{{id record}}",
"location":"{{location}}",
"start_date": "{{YYYYmmdd HHiiss}}",
"wolkvox_owner":"{{user}}",
"participants":{
"type":"participant",
"value":["{{user1}}", "{{user2}}", "{{user3}}"]
}
}
}'
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"operation\":\"{{operation}}\",\r\n \"module\":\"wolkvox_activities\",\r\n \"type\": \"meet\",\r\n \"fields\":{\r\n \"status\":\"created\",\r\n \"name\": \"{{name}}\",\r\n \"priority\": \"{{priority}}\",\r\n \"name_module\": \"{{module}}\",\r\n \"completion_date\": \"{{YYYYmmdd HHiiss}}\",\r\n \"remember\": {{remember}},\r\n \"reminder_date\": \"{{YYYYmmdd HHiiss}}\",\r\n \"description\": \"{{description}}\",\r\n \"id_record\": \"{{id record}}\",\r\n \"location\":\"{{location}}\",\r\n \"start_date\": \"{{YYYYmmdd HHiiss}}\",\r\n \"wolkvox_owner\":\"{{user}}\",\r\n \"participants\":{\r\n \"type\":\"participant\",\r\n \"value\":[\"{{user1}}\", \"{{user2}}\", \"{{user3}}\"]\r\n }\r\n\r\n }\r\n}");
Request request = new Request.Builder()
.url("https://sv9901.crmvox.com/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": "meet",
"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}}",
"location": "{{location}}",
"start_date": "{{YYYYmmdd HHiiss}}",
"wolkvox_owner": "{{user}}",
"participants": {
"type": "participant",
"value": [
"{{user1}}",
"{{user2}}",
"{{user3}}"
]
}
}
})
headers = {
'Wolkvox-Token': '{{token}}',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
KEY | DESCRIPCIÓN | EJEMPLO |
---|---|---|
code | Indica el código de estado de la respuesta. | “code”: 200 |
error | Proporciona detalles sobre el error que ocurrió durante la solicitud. | “error”: “null” |
msg | Muestra un mensaje descriptivo sobre el resultado de la solicitud. | “msg”: “Succesfully edit record” |
data | Es el conjunto de información obtenido como resultado de haber hecho la solicitud. | “data”: {
“wolkvox_id”: “64cb”
} |
wolkvox-id | Es la identificación del registro en el módulo. | “wolkvox_id”: “64cb” |
{
"code": 200,
"error": "null",
"msg": "Succesfully create record",
"data": {
"wolkvox_id": " "
}
}
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
Goiânia +55 (62) 99328 6605
Santiago de Chile +56 (2) 240 533 89
Atlanta +1 (678) 496 7474
Ciudad de Guatemala +502 (2) 314 1344
Ciudad de México +52 (55) 8526 36 34
Copyright © 2022 MICROSYSLABS S.A.S. Todos los derechos reservados. Cra 30 # 4A-45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia
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
ESPAÑA
Madrid +34 (910) 601 691
MÉXICO
Ciudad de México +52 (55) 8526 36 34
BRASIL
Brasilia +55 (61) 9836 4127
São Paulo +55 (12) 9811 155 83
ESTADOS UNIDOS
New York +1 (914) 373 71 36
REPÚBLICA DOMINICANA
Santo Domingo +1 (829) 249 69 68
CHILE
Santiago de Chile +56 (2) 240 533 89
GUATEMALA
Ciudad de Guatemala +502 (2) 314 1344
PERÚ
Lima +51 (1) 644 91 39
Copyright © 2022 MICROSYSLABS S.A.S.
Todos los derechos reservados.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia
Usamos cookies, se continuar a navegar assumimos que concorda. Pode ler mais sobre a utilização de cookies nas nossas políticas de privacidade e tratamento de dados pessoais
Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales