Contacto

Envía una tarjeta de contacto (vCard)

Endpoint

POST https://api.jelou.ai/v1/bots/{botId}/messages

Parámetros de Ruta

botId · string · required

Identificador único del bot que envía el mensaje.

Cuerpo de la Solicitud

type · string · required

Debe ser "contacts".

contacts · array · required

Array de objetos de contacto. Cada contacto puede incluir nombre, números de teléfono, correos electrónicos y direcciones.

userId · string · required

Identificador único del usuario que recibirá el mensaje.

Estructura del Objeto de Contacto

Show Propiedades del Contacto

contacts[].name · object

Información del nombre del contacto.

Show Propiedades del Nombre

contacts[].name.formatted_name · string

Nombre completo formateado del contacto.

contacts[].name.first_name · string

Nombre del contacto.

contacts[].name.last_name · string

Apellido del contacto.

contacts[].name.middle_name · string

Segundo nombre del contacto.

contacts[].phones · array

Array de números de teléfono del contacto.

Show Propiedades del Teléfono

contacts[].phones[].phone · string

Número de teléfono en formato E.164 (ej: [phone]).

contacts[].phones[].type · string

Tipo de número de teléfono (ej: “Mobile”, “Work”, “Home”).

contacts[].phones[].wa_id · string

ID de WhatsApp asociado con el número de teléfono.

contacts[].emails · array

Array de direcciones de correo electrónico del contacto.

Show Propiedades del Email

contacts[].emails[].email · string

Dirección de correo electrónico del contacto.

contacts[].emails[].type · string

Tipo de correo (ej: “Work”, “Personal”).

contacts[].addresses · array

Array de direcciones del contacto.

Show Propiedades de la Dirección

contacts[].addresses[].street · string

Dirección de la calle.

contacts[].addresses[].city · string

Nombre de la ciudad.

contacts[].addresses[].state · string

Estado o provincia.

contacts[].addresses[].zip · string

Código postal o ZIP.

contacts[].addresses[].country · string

Nombre del país.

contacts[].addresses[].country_code · string

Código ISO del país (ej: “US”, “MX”).

contacts[].addresses[].type · string

Tipo de dirección (ej: “Office”, “Home”).

Ejemplos de Solicitud

cURL

curl --request POST \
  --url https://api.jelou.ai/v1/bots/BOT_ID/messages \
  --header 'Authorization: Basic <Base64Encoded clientId:clientSecret>' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "contacts",
    "userId": "USER_ID",
    "contacts": [
      {
        "name": {
          "formatted_name": "Juan Pérez",
          "first_name": "Juan",
          "last_name": "Pérez"
        },
        "phones": [
          {
            "phone": "[phone]",
            "type": "Mobile",
            "wa_id": "1234567890"
          }
        ],
        "emails": [
          {
            "email": "[e-mail]",
            "type": "Work"
          }
        ],
        "addresses": [
          {
            "street": "Calle Principal 123",
            "city": "Ciudad de México",
            "state": "CDMX",
            "zip": "01000",
            "country": "México",
            "country_code": "MX",
            "type": "Office"
          }
        ]
      }
    ]
  }'

Respuesta

success · boolean

Indica si el mensaje fue enviado exitosamente.

messageId · string

Identificador único del mensaje enviado.

Ejemplo de Respuesta

{
  "success": true,
  "messageId": "msg_123456789"
}

Notas Importantes

Formato de Teléfono: Siempre usa formato E.164 para números de teléfono (ej: [phone]) para asegurar compatibilidad entre diferentes regiones.

Completitud del Contacto: Aunque todos los campos son opcionales, proporcionar información completa del contacto (nombre, teléfono, email) mejora la experiencia del usuario y hace los contactos más útiles.

Casos de Uso

• Compartir información de contacto de soporte
• Referir usuarios a miembros específicos del equipo
• Proporcionar información de tarjetas de presentación
• Compartir contactos de emergencia