fbpx

< / >

Cases Insert

Insertar casos

URL:

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

Descripción:

El API de insertar casos nos permite mediante el envío de parámetros insertar registros exclusivamente en dicho módulo ya configurado. 

¿Cómo funciona?:

Esta API funciona a través de un cuerpo de tipo “form-data” 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 

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

  • operation
  • case-type
  • responsible
  • owner
  • contact
  • description
  • status
  • priority
  • form
  • file
  • solution

¿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.

REQUEST

KEY
DESCRIPCIÓN
EJEMPLO
Wolkvox-Token
Es el token configurado por el cliente en la página de CRM.
A8K3J7F2
operation
Es el nombre de la operación del CRM.
modulodeprueba
case-type
Es el tipo de caso. Puedes usar “Request” para peticiones, “Complaints” para quejas, “Claims” para reclamos y “Suggestions” para sugerencias.
Request
responsible
Es el responsable del caso.
user@operation
owner
Es el propietario del caso.
user@operation
contact
Es el contacto ya existente del usuario al que crea un caso.
user@operation
description
Es la descripción del caso.
caso creado desde API
status
Es el estado del caso.
open
priority
Es la prioridad del caso.
low
form
Son los campos personalizados que tenemos parametrizados en nuestro CRM. Primero va el nombre del campo (name_field) y luego el valor que se va a ingresar en el campo (value_field). Los campos personalizados se van separando con una coma.
{“name_field”:”value_field”, “name_field”:”value_field”}
solution
Fin o resultado del proceso ejercido. Aquí va la solución al caso si el estado del caso tiene la condición “cerrado”. Por lo tanto llenar este campo no es requisito cuando el estado del caso es establecido con una condición de “abierto”.
Esto es un ejemplo de solución a un caso.
file
Son los archivos adjuntos. Los formatos compatibles son los siguientes: .xlsx, .csv .pdf .jpg .png .docx .mp4 .mp3 .wmv .wma .wap .doc .jpeg .avi .bmp .bpm .avi .mov .tiff .docx .zip .7z .rar

REQUEST

				
					<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/cases/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 => array('operation' => '{operation}','case-type' => '{case-type}','responsible' => '{responsible}','owner' => '{owner}','contact' => '{contact}','description' => '{description}','status' => '{status}','priority' => '{baja}','form' => '{}'),
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token: {Wolkvox-Token}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

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

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