fbpx

< / >

Insert

Insertar actividad de tipo llamada

URL:

https://{{wolkvox_server}}/server/API/v2/custom/insert.php

Descripción:

La siguiente configuración de la API nos permite agregar actividades de tipo llamada en los módulos de nuestro CRM.

¿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
  • module
  • fields
  • status
  • name
  • priority
  • name_module
  • completion_date
  • remember
  • reminder_date
  • description
  • id_record
  • location
  • wolkvox_owner
  • phone
  • type
  • country
  • code
  • value

REQUEST

KEY
DESCRIPCIÓN
EJEMPLO
Wolkvox-Server
Nomenclatura del servidor de la operación.
wolkvox_server.crmvox.com
Wolkvox-Token
Token generado en el módulo de CRM en donde vas a consumir la API.
token
operation
Es el nombre de la operación del CRM.
“My-CRM-operation”
module
Se utiliza para indicar que se desea hacer una inserción en la lista de actividades del CRM.
“module”:”wolkvox_activities”
type
Tipo de actividad a crear.
“type”: “task”
fields
Es el conjunto de atributos o parámetros de datos que se envían a la API para crear una nueva tarea en el módulo seleccionado. Cada campo corresponde a una pieza específica de información sobre la tarea, como su estado, nombre, prioridad, fecha de finalización, etc. La API espera que estos campos estén en formato JSON, donde cada campo se representa como un par clave-valor.
“fields”: { }
status
Estado de la actividad.
“status”: “created”
name
Nombre de la actividad.
“name”: “Nombre de la actividad”
priority
Prioridad de la actividad. El valor puede ser “high” para alta, “normal” para normal o “low” para baja.
“priority”: “low”
name_module
Nombre del módulo donde deseas agregar la actividad.
“name_module”: “cases”
completion_date
Fecha de finalización de la actividad con formato de año-mes-día hora-minutos-segundos.
“completion_date”: “2023-07-30 00:00:00”
remember
Indica si deseas activar (true) o no (false) un recordatorio.
“remember”: true
reminder_date
Establece la fecha para cuando desees que se active el recordatorio. El formato es año-mes-día hora-minutos-segundos.
“reminder_date”: “2023-07-29 00:00:00”
description
Descripción de la actividad.
“description”: “Esto es una descripción de la actividad”
id_record
Código de identificación del registro del módulo seleccionado donde deseas añadir la actividad.
“id_record”: “código de id”
wolkvox_owner
Usuario dueño de la actividad.
“wolkvox_owner”: “ADMIN_@mimodulo”
phone
Este campo se utiliza para proporcionar los detalles de contacto del teléfono asociados con la actividad. Se utiliza para especificar el número de teléfono del remitente o destinatario en la actividad de llamada.
“phone”: { }
type
Indica que el tipo del número de teléfono proporcionado en la API. En este caso se indica que el número de teléfono proporcionado en la API corresponde a un número de teléfono estándar utilizado para comunicaciones telefónicas.
“type”:”telephone”
country
Indica el país asociado al número de teléfono.
“country”: “COLOMBIA”
code
Se utiliza para especificar el código del país asociado al número de teléfono.
“code”:”57″
value
Se utiliza para especificar el valor numérico del número de teléfono asociado a la actividad.
“value”:”1234567898″

REQUEST

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/custom/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 =>'{
    "operation":"{{operation}}",
    "module":"wolkvox_activities",
    "type": "call",
    "fields":{
         "status":"created",
        "name": "{{name}}",
        "priority": "{{priority}}",
        "name_module": "{{module}}",
        "completion_date": "{{YYYYmmdd HHiiss}}",
        "remember": {{remember}},
        "reminder_date": "{{YYYYmmdd HHiiss}}",
        "description": "{{description}}",
        "id_record": "{{id record}}",
        "location":"{{location}}",
        "wolkvox_owner":"{{owner}}",
        "phone": {
            "type":"telephone",
               "country":  "{{country}}",
               "code":"{{country code}}",
               "value":"{{phone}}"

        }

    }
}',
  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”: “64cb” }
wolkvox_id
Es la identificación del registro en el módulo.
“wolkvox_id”: “64cb”
				
					{
    "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

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