Perfil de empresa

Last update: 4 days ago by Irais Aguirre

Resumen para integración
URL base: https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services
Token: de administración, en el encabezado Authorization: Bearer {{admin-token}} (cómo generarlo)
Endpoints en esta página:
GET /v1/profile: Obtener perfil de empresa
POST /v1/profile: Actualizar perfil de empresa

Consulta y actualiza el perfil de empresa de un número de teléfono: información, dirección, descripción, correo, categoría y sitios web.

Obtener perfil de empresa

Petición

Petición de Obtener perfil de empresa:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/profile
Método	GET

Encabezados

Encabezados de Obtener perfil de empresa:

Nombre	Descripción	Tipo	Requerimientos
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio
phone_number_id	Número de teléfono de la empresa, con código de país. Ejemplo: 5215500000000.	String	Obligatorio

Ejemplo

Ejemplo completo de Obtener perfil de empresa:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/profile' \
--header 'phone_number_id: 5215500000000' \
--header 'Authorization: Bearer {{admin-token}}'

Respuesta

Respuesta de Obtener perfil de empresa:

Nombre	Descripción	Tipo
about	Texto "Información" del negocio. Aparece en el perfil, debajo de la foto, el número de teléfono y los botones de contacto.	String
address	Dirección del negocio.	String
description	Descripción del negocio.	String
email	Correo electrónico del negocio.	String
vertical	Categoría del negocio.	String
websites	URL asociadas al negocio, por ejemplo, su sitio web o su página de Facebook o Instagram. Incluye http:// o https://.	Array
profile_picture_url	URL de la foto de perfil.	String

{
    "about": "<Business Profile About>",
    "address": "<Business Profile Address>",
    "description": "<Business Profile Description>",
    "email": "<Business Profile Email>",
    "profile_picture_url": "https://pps.whatsapp.net/v/t61.24694-24/628788792_1980972062842455_4262174738568759725_n.jpg",
    "vertical": "<Business Profile Vertical>",
    "websites": ["https://www.whatsapp.com", "https://www.facebook.com"]
}

Actualizar perfil de empresa

Petición

Petición de Actualizar perfil de empresa:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/profile
Método	POST
Tipo	application/json

Encabezados

Encabezados de Actualizar perfil de empresa:

Nombre	Descripción	Tipo	Requerimientos
Content-Type	application/json	String	Obligatorio
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio
phone_number_id	Número de teléfono de la empresa, con código de país. Ejemplo: 5215500000000.	String	Obligatorio

Cuerpo

Campos del cuerpo de Actualizar perfil de empresa:

Nombre	Descripción	Tipo	Requerimientos
about	Texto "Información" del negocio. Aparece en el perfil, debajo de la foto, el número de teléfono y los botones de contacto.	String	Opcional. Hasta 139 caracteres. Admite emojis, pero no sus valores Unicode (codifícalos con Java o JavaScript). Puede incluir hipervínculos, pero no se muestran como enlaces. No admite formato.
address	Dirección del negocio.	String	Opcional. Máximo 256 caracteres.
description	Descripción del negocio.	String	Opcional. Máximo 256 caracteres.
email	Correo electrónico del negocio.	String	Opcional. Máximo 128 caracteres.
profile_picture_url	URL de la foto de perfil del negocio.	String	Opcional.
vertical	Categoría del negocio. Los valores pueden ser: ALCOHOL: Bebidas alcohólicas APPAREL: Ropa e indumentaria AUTO: Automotor BEAUTY: Belleza, spa y salón de belleza EDU: Educación ENTERTAIN: Entretenimiento EVENT_PLAN: Planificación y servicio de eventos FINANCE: Finanzas y servicios bancarios GOVT: Servicio público GROCERY: Comida y comestibles HEALTH: Medicina y salud HOTEL: Hoteles y alojamientos NONPROFIT: Organización sin fines de lucro ONLINE_GAMBLING: Apuestas y juegos en línea OTC_DRUGS: Medicamentos sin receta OTHER: Otro PHYSICAL_GAMBLING: Juegos y apuestas presenciales PROF_SERVICES: Servicios profesionales RESTAURANT: Restaurante RETAIL: Comercio y minorista TRAVEL: Viajes y transporte	String	Opcional. Puede ser una cadena vacía o uno de los valores indicados.
websites	URL asociadas al negocio, por ejemplo, su sitio web o su página de Facebook o Instagram. Incluye http:// o https://.	Array	Opcional. Hasta 2 sitios web de máximo 256 caracteres cada uno (validado por Meta).

Nota: los valores permitidos de vertical y los límites de websites los valida Meta, no este servicio.

Ejemplo

Ejemplo completo de Actualizar perfil de empresa:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/profile' \
--header 'Content-Type: application/json' \
--header 'phone_number_id: 5215500000000' \
--header 'Authorization: Bearer {{admin-token}}' \
--data '{
    "about": "<Business Profile About>",
    "address": "<Business Profile Address>",
    "description": "<Business Profile Description>",
    "email": "<Business Profile Email>",
    "vertical": "RETAIL",
    "websites": ["https://www.whatsapp.com", "https://www.facebook.com"]
}'

Respuesta

Respuesta de Actualizar perfil de empresa:

Nombre	Descripción	Tipo
code	Código de respuesta. Si la petición es correcta, el valor es 0.	Integer
detail	Detalle de la respuesta. Si la petición es correcta, el valor es "Success".	String

{
    "code": 0,
    "detail": "Success"
}

Whatsapp — Anterior

Perfil y logo

Foto de perfil