fbpx

< / >

Insert

Insert record with attachments

URL:

https://crm.wolkvox.com/server/API/v2/custom/insertAttach.php

Descripción:

Esta API permite insertar registros con archivos adjuntos en base 64.

¿Cómo funciona?:

  • El consumo de esta API se realiza mediante el método POST.
  • En la cabecera de la petición se requiete “Wolkvox-Token” con el token generado en su operación.
  • 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. Actualmente, los servidores disponibles son: “sv0001.crmvox.com” y “crm.wolkvox.com”.
  • El cuerpo debe construirse en formato “raw”.
  • En el cuerpo de la petición se requiere: “operation”, “module” y “fields”.

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

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-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.
“operation”: “modulodeprueba”
module
Nombre del módulo en el cual deseas insertar un nuevo registro con archivos adjuntos en base 64.
“module”: “contacts”
fields
Campos del módulo donde insertarás un nuevo registro. El campo de tipo “Adjuntos” debe tener el mismo nombre con el que lo creaste.
“fields”: { “idcontact”: “1010”, “namecontact”: “Harper Lincoln”, “emailcontact”: “[email protected]”, “Adjuntos”: [ ” ” ] } }

REQUEST

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{crm_server}}/server/API/v2/custom/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": "",
    "module": "",
    "fields": {
        "campoadjuntos": [
            ""
        ]
    }
}',
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token: {{Wolkvox-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”: “”
				
					{
    "code": 200,
    "error": "null",
    "msg": "Succesfully create record",
    "data": {
        "wolkvox_id": ""
    }
}
				
			
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

We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data