Integraciones

Registrar el contacto de una reserva

POST/integraciones/calendario/prospecto

Registra o localiza el contacto antes de reservar una cita. token autentica la solicitud y tokenIntegracion identifica la integración receptora. Ambos se envían en el cuerpo y pueden corresponder a la misma integración. Se aplican las reglas de recepción de contactos, incluido el requisito de correo o movil y el reconocimiento de reintentos mediante trid. Devuelve un objeto. Comprueba que tkProspecto esté presente antes de crear la cita; un error de procesamiento puede dejar la respuesta sin contenido.

Parámetros

Nombre	Tipo	Validación	Descripción
`trid`	uniqueidentifier		Cuerpo: UUID de la solicitud. Reutiliza el mismo valor al reintentar una solicitud: si ya existe en el historial de la cuenta, devuelve action: duplicated sin volver a procesarla. No lo reutilices para solicitudes distintas.
`gbraid`	varchar		Cuerpo: Identificador de clic publicitario. Hasta 512 caracteres.
`wbraid`	varchar		Cuerpo: Identificador de clic publicitario. Hasta 512 caracteres.
`token`	String	Requerido	Cuerpo: Token de integración utilizado para consultar la agenda. Se envía en el cuerpo, no solo en el encabezado.
`tokenIntegracion`	String	Requerido	Cuerpo: Token completo de la integración, incluido su prefijo si lo tiene. Conserva el valor proporcionado por Upnify.
`tokenUsuario`	String		Cuerpo: Identificador del ejecutivo que recibirá el contacto. Se utiliza para la asignación.
`nombre`	String		Cuerpo: Nombre del contacto. Se conservan hasta 128 caracteres.
`apellidos`	String		Cuerpo: Apellidos del contacto. Se conservan hasta 128 caracteres.
`correo`	String		Cuerpo: Correo del contacto. Debes enviar correo o movil para que se procese el contacto.
`movil`	String		Cuerpo: Móvil del contacto. Debes enviar movil o correo; incluye el prefijo internacional cuando lo conozcas.
`telefono`	String		Cuerpo: Teléfono del contacto.
`telefono2`	String		Cuerpo: Teléfono adicional.
`empresa`	String		Cuerpo: Nombre de la compañía del contacto.
`puesto`	String		Cuerpo: Puesto del contacto.
`comentarios`	String		Cuerpo: Comentario de la solicitud. Hasta 8000 caracteres.
`tkFase`	String		Cuerpo: Identificador de la fase inicial.
`fase`	String		Cuerpo: Nombre o identificador de una fase. tkFase tiene prioridad para un contacto nuevo.
`tkOrigen`	String		Cuerpo: Identificador del origen del contacto; tiene prioridad sobre origen.
`origen`	String		Cuerpo: Nombre o identificador del origen.
`tkEtiqueta`	String		Cuerpo: Identificadores de etiquetas separados por comas.
`etiqueta`	String		Cuerpo: Nombre o identificador de la primera etiqueta.
`etiqueta2`	String		Cuerpo: Nombre o identificador de una segunda etiqueta.
`etiqueta3`	String		Cuerpo: Nombre o identificador de una tercera etiqueta.
`idPais`	String		Cuerpo: Código del país. Si se omite o no es válido se aplica el país de la cuenta o del ejecutivo.
`pais`	String		Cuerpo: Nombre del país para resolver su código.
`idEstado`	String		Cuerpo: Código del estado.
`pestado`	String		Cuerpo: Nombre del estado para resolver su código.
`ciudad`	String		Cuerpo: Ciudad del contacto.
`pciudad`	String		Cuerpo: Texto complementario de ciudad.
`idMunicipio`	String		Cuerpo: Identificador del municipio.
`direccion1`	String		Cuerpo: Dirección principal.
`calle`	String		Cuerpo: Calle que se agrega a la dirección principal.
`direccion2`	String		Cuerpo: Dirección complementaria.
`codigoPostal`	String		Cuerpo: Código postal.
`refiere`	String		Cuerpo: Persona o referencia de origen del contacto.
`sexo`	String		Cuerpo: Valor de sexo del contacto.
`esCliente`	Integer		Cuerpo: 1 para crear como cliente; 0 para crear como prospecto.
`web`	String		Cuerpo: Sitio web del contacto.
`paginaWeb`	String		Cuerpo: Texto de sitio web adicional.
`url`	String		Cuerpo: URL de origen de la solicitud. Hasta 512 caracteres.
`referrer`	String		Cuerpo: Página de referencia. Hasta 512 caracteres.
`cp`	String		Cuerpo: Objeto JSON serializado con los campos personalizados. Sus claves dependen de los campos configurados en la cuenta.
`datosAdicionales`	String		Cuerpo: Objeto JSON serializado con datos adicionales del contacto.
`firma`	String		Cuerpo: Firma asociada al contacto.
`tkEvento`	String		Cuerpo: Identificador de un evento para registrar el contacto.
`tkWidget`	String		Cuerpo: Identificador del widget desde el que se registra.
`tkWidgetActivacion`	String		Cuerpo: Identificador de la activación del widget.
`tkPlantillaCorreo`	String		Cuerpo: Identificador de una plantilla que se enviará al contacto cuando corresponda.
`gclid`	String		Cuerpo: Identificador de clic publicitario. Hasta 512 caracteres.
`fbclid`	String		Cuerpo: Identificador de clic publicitario. Hasta 512 caracteres.
`utm_source`	String		Cuerpo: Fuente de campaña. Hasta 512 caracteres.
`utm_medium`	String		Cuerpo: Medio de campaña. Hasta 512 caracteres.
`utm_campaign`	String		Cuerpo: Campaña. Hasta 512 caracteres.
`utm_term`	String		Cuerpo: Término de búsqueda. Hasta 512 caracteres.
`utm_content`	String		Cuerpo: Contenido de campaña. Hasta 512 caracteres.
`utm_date`	String		Cuerpo: Fecha de atribución. Hasta 512 caracteres.
`customfield1`	String		Cuerpo: Valor adicional de atribución 1. Hasta 512 caracteres.
`customfield2`	String		Cuerpo: Valor adicional de atribución 2. Hasta 512 caracteres.
`customfield3`	String		Cuerpo: Valor adicional de atribución 3. Hasta 512 caracteres.
`customfield4`	String		Cuerpo: Valor adicional de atribución 4. Hasta 512 caracteres.
`customfield5`	String		Cuerpo: Valor adicional de atribución 5. Hasta 512 caracteres.

Respuesta

Nombre	Tipo	Descripción
`updated`	Boolean	true cuando action es updated; false para las demás acciones.
`tkProspecto`	String	Identificador del contacto. Puede faltar si no se obtuvo un contacto.
`action`	String	created, updated o duplicated cuando el procesamiento devuelve una acción.

Solicitud

curl --request POST \
  --url https://api.upnify.com/integraciones/calendario/prospecto \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "token": "P01AP00000000-0000-4000-8000-000000000001",
  "tokenIntegracion": "P01AP00000000-0000-4000-8000-000000000001",
  "nombre": "Persona de ejemplo",
  "correo": "persona@example.com",
  "trid": "00000000-0000-4000-8000-000000000001"
}'async function ejecutar() {
  const response = await fetch("https://api.upnify.com/integraciones/calendario/prospecto", {
    method: "POST",
    headers: {"Accept": "application/json", "Content-Type": "application/json"},
    body: JSON.stringify({"token":"P01AP00000000-0000-4000-8000-000000000001","tokenIntegracion":"P01AP00000000-0000-4000-8000-000000000001","nombre":"Persona de ejemplo","correo":"persona@example.com","trid":"00000000-0000-4000-8000-000000000001"})
  });
  const text = await response.text();
  if (!response.ok) throw new Error(`HTTP ${response.status}: ${text}`);
  const data = text ? JSON.parse(text) : null;
  // Usa data en tu aplicación sin exponer tokens o datos personales.
  console.log("Estado HTTP:", response.status);
}

ejecutar().catch(console.error);// Node.js 18 o posterior.
async function ejecutar() {
  const response = await fetch("https://api.upnify.com/integraciones/calendario/prospecto", {
    method: "POST",
    headers: {"Accept": "application/json", "Content-Type": "application/json"},
    body: JSON.stringify({"token":"P01AP00000000-0000-4000-8000-000000000001","tokenIntegracion":"P01AP00000000-0000-4000-8000-000000000001","nombre":"Persona de ejemplo","correo":"persona@example.com","trid":"00000000-0000-4000-8000-000000000001"})
  });
  const text = await response.text();
  if (!response.ok) throw new Error(`HTTP ${response.status}: ${text}`);
  const data = text ? JSON.parse(text) : null;
  // Usa data en tu aplicación sin exponer tokens o datos personales.
  console.log("Estado HTTP:", response.status);
}

ejecutar().catch(console.error);import json
import requests

response = requests.request(
    "POST",
    "https://api.upnify.com/integraciones/calendario/prospecto",
    headers={'Accept': 'application/json', 'Content-Type': 'application/json'},
    json=json.loads('{"token":"P01AP00000000-0000-4000-8000-000000000001","tokenIntegracion":"P01AP00000000-0000-4000-8000-000000000001","nombre":"Persona de ejemplo","correo":"persona@example.com","trid":"00000000-0000-4000-8000-000000000001"}'),
    timeout=30,
)
response.raise_for_status()
data = response.json() if response.text else None
# Usa data en tu aplicación sin exponer tokens o datos personales.
print("Estado HTTP:", response.status_code)package main

import (
  "fmt"
  "io"
  "net/http"
  "time"
  "strings"
)

func main() {
  body := strings.NewReader(`{"token":"P01AP00000000-0000-4000-8000-000000000001","tokenIntegracion":"P01AP00000000-0000-4000-8000-000000000001","nombre":"Persona de ejemplo","correo":"persona@example.com","trid":"00000000-0000-4000-8000-000000000001"}`)
  request, err := http.NewRequest("POST", "https://api.upnify.com/integraciones/calendario/prospecto", body)
  if err != nil { panic(err) }
  request.Header.Set("Accept", "application/json")
  request.Header.Set("Content-Type", "application/json")
  client := &http.Client{Timeout: 30 * time.Second}
  response, err := client.Do(request)
  if err != nil { panic(err) }
  defer response.Body.Close()
  data, err := io.ReadAll(response.Body)
  if err != nil { panic(err) }
  if response.StatusCode < 200 || response.StatusCode >= 300 {
    panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data))
  }
  fmt.Println("Estado HTTP:", response.StatusCode)
}using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.upnify.com/integraciones/calendario/prospecto");
request.Headers.Add("Accept", "application/json");
request.Content = new StringContent("{\"token\":\"P01AP00000000-0000-4000-8000-000000000001\",\"tokenIntegracion\":\"P01AP00000000-0000-4000-8000-000000000001\",\"nombre\":\"Persona de ejemplo\",\"correo\":\"persona@example.com\",\"trid\":\"00000000-0000-4000-8000-000000000001\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
var data = await response.Content.ReadAsStringAsync();
response.EnsureSuccessStatusCode();
Console.WriteLine($"Estado HTTP: {(int)response.StatusCode}");

Respuesta

{
  "updated": false,
  "tkProspecto": "P-00000000-0000-4000-8000-000000000001",
  "action": "created"
}

Registrar el contacto de una reserva

Parámetros

Respuesta

Solicitud

Registrar al visitante de una reserva

Respuesta

Contacto disponible para la reserva (HTTP 200)