OkeyBot
🦸‍♂️ Soporte dedicado🚀 Crear cuenta🟢 API de WhatsApp
  • 👋Bienvenido a OkeyBot
  • 📖Glosario de Términos
  • 🚀Comenzando
    • ⚡Inicio Rápido
    • 🔌Conectando un Canal
    • 👥Invita a tus Colegas
    • ✏️ Responder a los Mensajes
    • 🤖Creando un Chatbot
  • 🎛️ Módulos de navegación
    • 💻Escritorio
    • 💬Mensajes
      • Asignación y Cierre de Conversación
      • Interacción con IA
      • Asistente de IA
    • 👤Contactos
      • Detalles de contacto
      • Sugerencias de Fusión de Contactos
      • Actividad de contacto
      • Canales del contacto
      • Importar Contactos
      • Exportar contactos
      • Segmentos
    • 📣Difusiones
      • Gestión de difusiones
      • Enviar difusión
      • Difusiones y flujos de trabajo
      • Solución de conflictos
    • 📑Flujos de Trabajo
      • Disparadores
      • Pasos
    • 📊Reportes
      • Conversaciones
      • Respuestas
      • Resoluciones
      • Mensajes
      • Contactos
      • Asignaciones
      • Tabla de clasificación
      • Usuarios
      • Difusiones
  • ⚙️Ajustes
    • 🛠️Administrar Espacio de Trabajo
    • ☸️Configuración General
    • 👥Usuarios
      • Niveles de acceso
    • 🫂Equipos
    • 🔛Canales
      • Menú persistente
    • 🆙Widgets de Crecimiento
    • 🔢Campos Personalizados
    • ⛓️Integraciones
    • 📝Notas de Cierre
    • 🏃Atajos
    • 🗂️Archivos
    • 📉Exportación de Datos
    • 🧠IA
  • 👥Cuenta de usuario
    • 👤Perfil del Usuario
    • ✅Actividad del Usuario
    • 🔔Notificaciones
    • 🔁Restablecer su Contraseña
  • 📞Contactos y mensajes
    • 🎯Variables Dinámicas
    • 👁️Búsqueda de Contactos y Bandeja de Entrada Personalizada
    • 🗨️Conversaciones
  • 🌐Canales de mensajería
    • 🗃️Resumen de Canales
    • 📌Facebook Messenger
      • Chat online de Facebook
      • Respuestas privadas
      • Mensaje de etiqueta
    • 📌 Instagram
    • 📌 WhatsApp
      • WhatsApp Cloud API META
      • WhatsApp Business API
        • Configuración WhatsApp Business API
      • 360Dialog WhatsApp
      • Twilio WhatsApp
      • MensajeBird WhatsApp
      • WhatsApp de Vonage
      • Plantillas de mensajes de WhatsApp
    • 📌 Widget de Chat Online
      • Instalar en WordPress
      • Instalar en Shopify
      • Instalar en Wix
      • Instalar en Joomla
      • Instalar en Squarespace
    • 📌Mensajes de Google Business
    • 📌LINE
    • 📌 Telegram
    • 📌 Viber
    • 📌 SMS
      • Twilio SMS
      • MessageBird SMS
      • Vonage SMS
    • 📌Twitter
    • 📌 WeChat
    • 📌 Email
      • Gmail
      • Otros proveedores
    • 📌Canal Personalizado
  • 🔌Integraciones
    • 🆗Dialogflow
      • Conectando a Dialogflow
      • Gestión de intenciones
        • Parámetros
          • Etiquetado
          • Apagando el Bot
          • Cerrar una conversación
          • Asignar
          • Envío de notificaciones personalizadas
          • Darse de baja
          • Campos de contacto y valores
          • Envío de atajos
          • Envío de archivos
          • Solicitando ubicación
        • Eventos
        • Plantillas de respuesta
        • Cargas útiles personalizadas
        • Request de webhook (Fulfillment)
    • 🆕Zapier
    • 👨‍💻API de Desarrollador
    • 🕸️Webhooks
  • ☁️Api de desarrolladores
    • 📥API de Contactos
    • 💭API de Mensajes
      • API Mensajes de plantillas
  • 🤝Programas de asociación
    • 💡Visión General
    • 💲Programa de Afiliación
    • ®️Programa de Socios
      • Apariencia de la plataforma
      • Nombre de dominio personalizado
      • API de revendedor
  • 📣Enlaces de interés
  • 🦸‍♂️ Soporte Ejecutivo
  • 🚨Actualizaciones
    • Octubre 2023 [v11.0] Nuevo disparador, paso de flujo de trabajo y más
    • Octubre 2023 [v10.9] Nuevo disparador de flujos de trabajo: Anuncios de clic-to-chat
    • Octubre 2023 [v10.8] Nueva experiencia de conexión de canales
    • Septiembre 2023 [v10.7] Saluda al nuevo Asistente de IA
    • Septiembre 2023 [v10.6] Mejoras en el flujo de trabajo y más
    • Agosto 2023 [10.5] Mejoras en el comportamiento del canal y configuración de Messenger
    • Agosto 2023 [v10.4] ¡IA de Okeybot ya está aquí!
    • Agosto 2023 [v10.3] Capacidades de búsqueda mejoradas en el módulo de mensajes
    • Julio 2023 [v10.2] Experiencia al usuario mejorada: nuevas funciones
    • Julio 2023 [v10.1] Nueva integración de Make.com
    • Julio 2023 [v10.0] Nuevas incorporaciones a las plantillas de mensajes de WhatsApp
    • Julio 2023 [v9.9] Experiencia de correo electrónico nueva y mejorada
    • Junio 2023 [v9.8] Experiencia de navegación de plantillas de flujo de trabajo mejorada
    • Junio 2023 [v9.7] Mejoras en los flujos de trabajo y experiencia de usuarios
    • Junio 2023 [v9.6] Nuevas actualizaciones para mejorar la experiencia
    • Mayo 2023 [v9.5] Análisis de reportes y difusiones renovados
    • Abril 2023 [v9.4] Números de teléfonos y correos estandarizados
    • Abril 2023 [v9.3] Okeybot es un proveedor oficial de WhatsApp
    • Marzo 2023 [v9.2] Pegatinas recibidas
    • Marzo 2023 [v9.1] Nuevo Módulo de Difusiones
    • Febrero 2023 [v9.0] Nuevas plantillas de Flujos de Trabajo y mejoras en las de WhatsApp
    • Enero 2023 [v8.9] Actualizado con los nuevos eventos webhooks
    • Enero 2023 [v8.8] ¡Mensajes de Google Business está aquí!
    • Diciembre 2022 [v8.7] Activar flujos de trabajo con webhooks entrantes
    • Diciembre 2022 [v8.6] ¡Protección mejorada contra virus!
    • Diciembre 2022 [v8.5] Nuevos Widgets para su Sitio Web y Nuevos Idiomas Disponibles.
    • Noviembre 2022 [v8.4] Nuevo Diseño en Detalles del Contacto e Idioma Árabe Disponible
    • Octubre 2022 [v8.3.6] Mejoras en Mensajería y Canales, Idioma Portugués Disponible, entre otros.
    • Octubre 2022 [v8.3.5] Actualización de la API de Contactos y Mensajería
    • Septiembre 2022 [v8.3.4]Construya la automatización de forma más intuitiva con estas mejoras.
    • Septiembre 2022 [v8.3.3] WhatsApp Cloud API
    • Agosto 2022 [v8.3.2] Importar contactos 2.0 y Idioma Español Disponible
    • Agosto 2022 [v8.3.1] No más conversaciones sin asignar cuando se cierran
    • Marzo 2022 [v8.3] Nuevos Accesos Directos, Variables y Condiciones de Flujo de Trabajo
    • Febrero 2022 [v8.2] Módulo de Mensajes Rediseñado, Nueva Integración de Canales Personalizados y más
    • Diciembre 2021 [v8.1] Nuevo Diseño de Navegación y Nuevos Pasos de Flujos de Trabajo
    • Noviembre 2021 [v8.0] Flujos de Trabajo (Automatización 2.0), y API de Mensajes de Plantilla
    • Agosto 2021 [v7.9] Plan Empresas, Mejoras en Mensajes de Plantillas de WhatsApp.
    • Agosto 2021 [v7.8] IMAP/SMTP, Mejoras Chat Web, Mensajes interactivos WhatsApp y más.
    • Julio 2021 [v7.7] ¡Instagram, mejoras en 360Dialog y más!
    • Junio 2021 [v7.6] Informes 2.0, Nota de cierre y más mejoras
    • Mayo 2021 [v7.5] Informes, Dashboard 2.0, Exportación de datos, Mensajes de voz, Zona horaria y más!
    • Febrero 2021 [v7.4] Combinación de contactos
Con tecnología de GitBook
En esta página
  • Peticiones
  • Obtener contacto por campo personalizado
  • Obtener contacto por ID
  • Actualizar contacto por ID
  • Agregar etiqueta por ID
  • Eliminar etiqueta por ID
  • Crear contacto
  • Códigos de error
  • No autorizado (estado HTTP → 401)
  • Demasiadas solicitudes (estado HTTP → 429)
  • Método no permitido (estado HTTP → 405)
  • General (Estado HTTP → 403)
  • Limitaciones

¿Te fue útil?

  1. Api de desarrolladores

API de Contactos

Le permite agregar, editar y recuperar información de contacto a través de API.

AnteriorWebhooksSiguienteAPI de Mensajes

Última actualización hace 2 años

¿Te fue útil?

La API 1.0 de Contactos y Mensajes quedará obsoleta en 2023. Le recomendamos encarecidamente que empiece a migrar a la nueva API pronto.

Comience a construir con la API de la próxima generación de okeybot.com. Consulte nuestra específica sobre la API.

Las llamadas a la API se realizan por canal. Los tokens se pueden generar usando el icono de llave, junto al canal deseado en . Hay un límite de frecuencia de 100 llamadas API por minuto.

Peticiones

La API de contactos se compone de varias solicitudes:

Obtener contacto por campo personalizado

Esta solicitud devuelve una lista de objetos de contacto con paginación.

/v1/contact/by_custom_field

Ejemplo de solicitud GET

Si desea recuperar una lista de contactos por campo personalizado de tipo booleano, asegúrese de utilizar TRUE o FALSE como valor.

curl -X GET \
      'https://app.okeybot.com/api/v1/contact/by_custom_field?name=firstName&value=Muhammad%20Mahin' \
      -H 'Authorization: Bearer {channel_token}' \
      -H 'Content-Type: application/json'

Respuesta: éxito (estado HTTP → 200)

{
      "data": [
        {
          "id": "1776025372480910",
          "custom_fields": {
            "firstName": "Mahin",
            "lastName": "Dar",
            "locale": "en_GB",
            "timezone": "5",
            "gender": "male",
            "phone": "123123",
            "email": "muhammad@okeybot.com",
            "customerid": "1"
          },
          "tags": [
            "Blog Updates",
            "Platform Updates"
          ],
          "created_at": 1575618542
        }
      ],
      "links": {
        "first": "http://app.okeybot.com/api/v1/contact/by_custom_field?page=1",
        "last": "http://app.okeybot.com/api/v1/contact/by_custom_field?page=1",
        "prev": null,
        "next": null
      },
      "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://app.okeybot.com/api/v1/contact/by_custom_field",
        "per_page": 10,
        "to": 1,
        "total": 1
      }
    }

Obtener contacto por ID

Esta solicitud devuelve un único objeto de contacto.

/v1/contact/{contact_id}

Ejemplo de solicitud GET

curl -X GET \
      https://app.okeybot.com/api/v1/contact/1776025372480910 \
      -H 'Authorization: Bearer {channel_token}' \
      -H 'Content-Type: application/json' \

Respuesta: éxito (estado HTTP → 200)

{
        "data": {
            "id": "1776025372480910",
            "custom_fields": {
                "firstName": "Mahin",
                "lastName": "Dar",
                "locale": "en_GB",
                "timezone": "5",
                "gender": "male",
                "phone": "123123",
                "email": "muhammad@okeybot.com",
                "customerid": "1"
            },
            "tags": [
                "Blog Updates",
                "Platform Updates"
            ],
            "created_at": 1575618542
        }
    }

Actualizar contacto por ID

Esta solicitud actualiza un valor de campo personalizado de contacto.

/v1/contact/{contact_id}

Ejemplo de solicitud PUT

curl -X PUT \
      https://app.okeybot.com/api/v1/contact/1776025372480910 \
      -H 'Authorization: Bearer {channel_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "custom_fields": [
            {
                "name": "firstName",
                "value": "Muhammad Mahin"
            },
            {
                "name": "lastName",
                "value": "Dar"
            }
        ]
    }'

Respuesta: éxito (estado HTTP → 200)

{
      "data": {
        "id": "cus_112233344555"
      }
    }

Limitaciones

Máximo 30 campos actualizados por solicitud.

Tenga en cuenta que en el caso del canal Viber, debido a una cierta limitación, la ID de contacto debe proporcionarse en un formato codificado en Base64 .

Agregar etiqueta por ID

Esta solicitud agrega etiquetas para un contacto.

/v1/contact/{contact_id}/tags

Ejemplo de solicitud POST

curl -X POST \
      https://app.okeybot.com/api/v1/contact/1776025372480910/tags \
      -H 'Authorization: Bearer {channel_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "tags": [
            "Blog Updates",
            "Platform Updates"
        ]
    }'

Respuesta: éxito (estado HTTP → 200)

{
        "status": "success",
        "message": "Contact Tags have been added successfully.",
        "data": []
    }

Limitaciones

Máximo 10 etiquetas agregadas por solicitud.

Eliminar etiqueta por ID

Esta solicitud elimina las etiquetas de un contacto.

/v1/contact/{contact_id}/tags

Ejemplo de solicitud DELETE

curl -X DELETE \
      https://app.okeybot.com/api/v1/contact/1776025372480910/tags \
      -H 'Authorization: Bearer {channel_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "tags": [
            "Blog Updates",
            "Platform Updates"
        ]
    }'

Respuesta: éxito (estado HTTP → 200)

{
        "status": "success",
        "message": "Contact Tags deleted successfully.",
        "data": []
    }

Limitaciones

Máximo de 10 etiquetas eliminadas por solicitud.

Tenga en cuenta que en el caso del canal Viber, debido a una cierta limitación, la ID de contacto debe proporcionarse en un formato codificado en Base64.

Crear contacto

Esta solicitud crea un contacto y establece valores para sus campos personalizados.

/v1/contact

Ejemplo de solicitud POST

curl -X POST \
      https://app.okeybot.com/api/v1/contact/ \
      -H 'Authorization: Bearer {channel_api_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "custom_fields": [
            {
                "name": "phone",
                "value": "03244077087"
            },
            {
                "name": "firstName",
                "value": "Muhammad Mahin"
            },
            {
                "name": "lastName",
                "value": "Dar"
            }
        ]
    }'

Respuesta: éxito (estado HTTP → 200)

{
        "data": {
            "id": "cus_112233344555"
        }
    }

Códigos de error

No autorizado (estado HTTP → 401)

{
        "status": "error",
        "message": "API Token is invalid.",
        "data": []
    }

Demasiadas solicitudes (estado HTTP → 429)

    {
      "status": "error",
      "message": "Too many requests",
      "data": []
  }

Método no permitido (estado HTTP → 405)

    {
      "status": "error",
      "message": "405 Method Not Allowed.",
      "data": []
  }

General (Estado HTTP → 403)

    {
      "status": "error",
      "message": "Message String",
      "data": []
  }

Limitaciones

Máximo 30 campos creados por solicitud.

☁️
📥
documentación
Configuración
Obtener contacto por campo personalizado
Obtener contacto por ID
Actualizar contacto por ID
Añadir etiqueta por ID
Elimina la etiqueta de ID
Crear contacto