fbpx

< / >

Insert

Insertar casos con adjuntos

URL:

https://{{wolkvox_server}}/server/API/v2/custom/insert.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

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
Tipo de caso.
“case-type”: “Request”
responsible
Responsable del caso.
“responsible”: “ADMIN_@mymodule”
owner
Dueño del caso.
“owner”: “ADMIN_@mymodule”
contact
Contacto relacionado con el caso.
“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
Indica el estado actual del caso.
“status”: “abierto”
priority
Establece la prioridad del caso.
“priority”: “baja”
attachments
Aquí puedes agregar archivos adjuntos al caso.
“attachments”: [ ]

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;
				
			

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