logo
enes

Contactos

Last update: 4 days ago by Irais Aguirre

Resumen para integración

  • Endpoint: POST https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging
  • Token: de mensajería, en el encabezado Authorization: Bearer {{wa-msg-api-token}} (cómo generarlo)
  • Campos comunes: from, to (teléfono o BSUID) y type (detalle)
  • Valores de type en esta página: "contacts"
  • Respuesta: la misma para todos los mensajes (ver respuesta)

Mensajes para compartir uno o más contactos. Todos se envían con POST /v1/messaging; los encabezados, los campos comunes y la respuesta están en Conexión HTTP.

Contactos

Envía los datos de uno o más contactos. El campo type debe ser "contacts".

Cuerpo

Campos de Contactos, además de los campos comunes:

NombreDescripciónTipoRequerimientos
contactsLista con los datos de uno o más contactos.Array de objetos contactsObligatorio.

Objeto contacts

NombreDescripciónTipoRequerimientos
birthdayFecha de nacimiento del Contacto.StringOpcional.
addressesLista de direcciones del contacto.Array de objetos addressesOpcional.
emailsLista de correos del contacto.Array de objetos emailsOpcional.
nameObjeto con el nombre del contacto.ObjetoObligatorio.
orgObjeto con la compañía del contacto.ObjetoOpcional.
phonesLista de teléfonos del contacto.Array de objetos phonesOpcional.
urlsLista de URLs del contacto.Array de objetos urlsOpcional.

Objeto addresses

NombreDescripciónTipoRequerimientos
cityCiudad.StringOpcional.
countryPaís.StringOpcional.
country_codeCódigo ISO del país.StringOpcional.
stateEstado.StringOpcional.
streetCalle.StringOpcional.
typeValores comunes: WORK, HOME. Este servicio no los valida; cualquier cadena se reenvía tal cual.StringOpcional.
zipCódigo Postal.StringOpcional.

Objeto emails

NombreDescripciónTipoRequerimientos
emailCorreo del Contacto.StringOpcional.
typeValores comunes: WORK, HOME. Este servicio no los valida; cualquier cadena se reenvía tal cual.StringOpcional.

Objeto name

NombreDescripciónTipoRequerimientos
first_nameNombre del Contacto.StringObligatorio si middle_name y last_name no tienen valor.
middle_nameSegundo nombre del contacto.StringObligatorio si first_name y last_name no tienen valor.
last_nameApellido del Contacto.StringObligatorio si middle_name y first_name no tienen valor.
formatted_nameNombre Completo.StringObligatorio.
prefixPrefijo (p. ej. Sr., Dr.).StringOpcional.
suffixSufijo (p. ej. Jr., III).StringOpcional.

Objeto org

NombreDescripciónTipoRequerimientos
companyNombre de la compañía.StringOpcional.
departmentDepartamento dentro de la compañía.StringOpcional.
titlePuesto o cargo dentro de la compañía.StringOpcional.

Objeto phones

NombreDescripciónTipoRequerimientos
phoneTeléfono del Contacto.StringOpcional.
typeValores comunes: WORK, HOME. Este servicio no los valida; cualquier cadena se reenvía tal cual.StringOpcional.
wa_idID de WhatsApp del contacto.LongOpcional.

Objeto urls

NombreDescripciónTipoRequerimientos
urlURL del contacto.StringOpcional.
typeValores comunes: WORK, HOME. Este servicio no los valida; cualquier cadena se reenvía tal cual.StringOpcional.

Ejemplo

Ejemplo completo de Contactos (petición HTTP y cuerpo JSON):

Petición HTTP

curl -X POST 'https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging' \
-H 'Authorization: Bearer {{wa-msg-api-token}}' \
-H 'Content-Type: application/json' \
-d '{
    "from": "5215500000001",
    "to": "5215500000002",
    "type": "contacts",
    "contacts":[
        {
            "addresses": [
                {
                    "city": "México city",
                    "country": "México",
                    "country_code": "mx",
                    "state": "MX",
                    "street": "Paseo de la Reforma",
                    "type": "HOME",
                    "zip": "00000"
                }
        ],
            "birthday": "1970-01-01",
            "emails": [
                {
                    "email": "test@test.com",
                    "type": "WORK"
                }
            ],
            "name": {
                "first_name": "John",
                "formatted_name": "John Williams",
                "last_name": "Williams"
            },
            "org": {
                "company": "Facebook"
            },
            "phones": [
                {
                    "phone": "525536493568",
                    "type": "HOME"
                }
            ],
            "urls": [{
                "url":"https://facebook.com",
                "type":"WORK"
            }]
        }
    ]
}'

Body

{
    "from": "5215500000001",
    "to": "5215500000002",
    "type": "contacts",
    "contacts": [
        {
            "addresses": [
                {
                    "city": "Mexico City",
                    "country": "Mexico",
                    "country_code": "mx",
                    "state": "MX",
                    "street": "Paseo de la Reforma",
                    "type": "HOME",
                    "zip": "00000"
                }
            ],
            "birthday": "1970-01-01",
            "emails": [
                {
                    "email": "test@test.com",
                    "type": "WORK"
                }
            ],
            "name": {
                "first_name": "John",
                "last_name": "Williams",
                "formatted_name": "John Williams"
            },
            "org": {
                "company": "Facebook"
            },
            "phones": [
                {
                    "phone": "525536493568",
                    "type": "HOME"
                }
            ],
            "urls": [
                {
                    "url": "https://facebook.com",
                    "type": "WORK"
                }
            ]
        }
    ]
}

Anterior
Ubicación
Siguiente
Respuestas y reacciones