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

Insertar casos con adjuntos

< / >

Insert

Insertar casos con adjuntos

URL:

https://{{crm_server}}/server/API/v2/cases/insertAttach.php

Descripción:

La siguiente configuración de la API nos permite agregar casos con archivos adjuntos.

¿Cómo funciona?:

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:

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

– En el cuerpo de la petición se requiere:

operation
case-type
responsible
owner
contact
description
form
status
priority
attachments

¿Cómo usar la URL?:

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:

sv0001.crmvox.com
crm.wolkvox.com

¿Cómo determinar el servidor del CRM?

Acceda a la página inicial del CRM mediante el enlace: https://crm.wolkvox.com/.
Inicie sesión utilizando sus credenciales de CRM.
Una vez que haya iniciado sesión y esté en la página de inicio de su plataforma CRM, observe la barra de direcciones del navegador web. La URL en esta barra indica el servidor donde se aloja su operación.
Reemplace {{crm_server}} en la URL original con la URL específica de su servidor de CRM para asegurarse de que la API apunte correctamente a su instancia de 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.

Insertar archivos adjuntos en base 64

El campo attachments permite enviar archivos adjuntos en formato base64. Este campo acepta una lista de cadenas base64 que representan los archivos que se desean adjuntar.

"attachments": [ "base64string1", "base64string2" ]

REQUEST

KEY	DESCRIPCIÓN	EJEMPLO
Wolkvox-Server	Nomenclatura del servidor de la operación.	‘https://wolkvox_server.crmvox.com/server/API/v2/cases/insertAttach.php’
Wolkvox-Token	Token generado en el módulo de CRM en donde vas a consumir la API.	‘Wolkvox-Token: token’
operation	Nombre de la operación.	“operation”: “TheOperationName”
case-type.	Es el tipo de caso. Puedes usar “Request” para peticiones, “Complaints” para quejas, “Claims” para reclamos y “Suggestions” para sugerencias. También puedes colocar tipos de casos personalizados que hayas creado previamente en tu módulo de casos.	“case-type”: “Request”
responsible	Es el responsable del caso. Este dato de cada usuario se extrae desde la columna “Correo wolkvox” del listado de usuarios creados en su operación. Antes de consumir esta API, el usuario ya debería estar creado.	“responsible”: “ADMIN_@mymodule”
owner	Es el propietario del caso. Este dato de cada usuario se extrae desde la columna “Correo wolkvox” del listado de usuarios creados en su operación. Antes de consumir esta API, el usuario ya debería estar creado.	“owner”: “ADMIN_@mymodule”
contact	Es el contacto o cliente relacionado con el caso. El contacto se identifica mediante el correo electrónico que se le colocó al cliente en la columna “Correo contacto” en el módulo de contactos de su operación. Antes de consumir esta API, el contacto ya debería estar creado.	“contact”: “[email protected]”
description	Descripción del caso.	“description”: “Esta es la descripción del caso”
form	Este campo se utiliza para especificar detalles adicionales del caso.	“form”:{ “Subject”: “Este es un campo adicional creado en el CRM” }
status	Es el estado del caso. El valor que coloques en este campo ya debe estar creado en el módulo y para el tipo de caso especificado.	“status”: “abierto”
priority	Es la prioridad del caso. El valor que coloques en este campo ya debe estar creado en el módulo y para el tipo de caso especificado.	“priority”: “baja”
attachments	Aquí puedes agregar archivos (en base64) adjuntos al caso.	“attachments”: [ “base64string1”, “base64string2” ]
solution	Este campo es requerido si el estado asignado al caso tiene la condición de “Cerrado”. El objetivo de este campo es definir el resultado del caso. Es decir, aquí va la solución al caso . Por lo tanto no es requisito llenar este campo cuando el estado del caso asignado está relacionado con la condición de “Abierto”.	Esto es un ejemplo de solución a un caso.

REQUEST

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/cases/insertAttach.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}}",
    "case-type":"{{case type}}",
    "responsible":"{{responsible}}",
    "owner":"{{owner}}",
    "contact":"{{contact}}",
    "description":"{{description}}",
    "form":{
      "Subject": "{{subject}}"
    },
    "status": "{{status}}",
    "priority":"{{priority}}",
    "attachments": [  ]
}',
  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/cases/insertAttach.php' \
--header 'Wolkvox-Token: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operation":"{{operation}}",
    "case-type":"{{case-type}}",
    "responsible":"{{responsible}}",
    "owner":"{{owner}}",
    "contact":"{{contact}}",
    "description":"{{description}}",
    "form":{
      "Subject": "{{subject}}"
    },
    "status": "{{status}}",
    "priority":"{{priority}}",
    "attachments": [  ]
}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"operation\":\"{{operation}}\",\r\n    \"case-type\":\"{{case-type}}\",\r\n    \"responsible\":\"{{responsible}}\",\r\n    \"owner\":\"{{owner}}\",\r\n    \"contact\":\"{{contact}}\",\r\n    \"description\":\"{{description}}\",\r\n    \"form\":{\r\n      \"Subject\": \"{{subject}}\"\r\n    },\r\n    \"status\": \"{{status}}\",\r\n    \"priority\":\"{{priority}}\",\r\n    \"attachments\": [  ]\r\n}");
Request request = new Request.Builder()
  .url("https://{{wolkvox_server}}/server/API/v2/cases/insertAttach.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/cases/insertAttach.php"

payload = json.dumps({
  "operation": "{{operation}}",
  "case-type": "{{case-type}}",
  "responsible": "{{responsible}}",
  "owner": "{{owner}}",
  "contact": "{{contact}}",
  "description": "{{description}}",
  "form": {
    "{{campo-adicional}}": "{{valor-del-campo-adicional}}"
  },
  "status": "{{status}}",
  "priority": "{{priority}}",
  "attachments": []
})
headers = {
  'Wolkvox-Token': '{{token}}',
  'Content-Type': 'application/json'
}

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

print(response.text)

RESPONSE

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”:””,”idPrefijo”:””}
wolkvox_id	Es la identificación del registro en el módulo.	“wolkvox_id”: “”
idPrefijo	Es la identificación del prefijo del caso.	“idPrefijo”: “”

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

Posibles códigos de error