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

Editar casos y sus archivos adjuntos

< / >

Insert

Editar casos y sus archivos adjuntos

URL:

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

Descripción:

La siguiente configuración de la API nos permite editar casos y su lista de archivos adjuntos en base64.

¿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
wolkvox-id
responsible
owner
contact
status
priority
case-type
description
form
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.

REQUEST

KEY	DESCRIPCIÓN	EJEMPLO
Wolkvox-Server	Nomenclatura del servidor de la operación.	‘https://wolkvox_server.crmvox.com/server/API/v2/cases/updateCaseAttachment.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”
wolkvox-id	Código de identificación del caso.	“wolkvox-id”: “case ID”
case-type	Tipo de caso. Puedes usar “Request” para peticiones, “Complaints” para quejas, “Claims” para reclamos y “Suggestions” para sugerencias.	“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/updateCaseAttachment.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}}",
    "wolkvox-id":"{{wolkvox-id}}",
    "responsible": "{{responsible}}",
    "status": "{{status}}",
    "priority":"{{priority}}",
    "case-type": "{{request}}",
    "owner": "{{owner}}",
    "contact": "{{contact}}",
    "description": "{{description}}",
    "form":{
    },
    "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/updateCaseAttachment.php' \
--header 'Wolkvox-Token: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operation":"{{operation}}",
    "wolkvox-id":"{{wolkvox-id}}",
    "responsible": "{{responsible}}",
    "status": "{{status}}",
    "priority":"{{priority}}",
    "case-type": "{{case-type}}",
    "owner": "{{owner}}",
    "contact": "{{contact}}",
    "description": "{{description}}",
    "form":{
    },
    "attachments":[]
}'

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

payload = json.dumps({
  "operation": "{{operation}}",
  "wolkvox-id": "{{wolkvox-id}}",
  "responsible": "{{responsible}}",
  "status": "{{status}}",
  "priority": "{{priority}}",
  "case-type": "{{case-type}}",
  "owner": "{{owner}}",
  "contact": "{{contact}}",
  "description": "{{descriptionñ}}",
  "form": {
    "Additional-field": "{{additional-field-text}}"
  },
  "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”:””}
idPrefijo	Es la identificación del prefijo del caso.	“idPrefijo”: “”

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

Posibles códigos de error