RCS Brand y Agent Builder utilizando Channel Manager API
Para usar la oferta de RCS de Vonage, una marca debe registrar algunos metadatos a nivel de marca, luego crear un agente que represente a la marca en RCS, obtener su verificación y luego usarlo en Messages API al enviar mensajes RCS. La API de Channel Manager proporciona puntos finales para administrar estas entidades (marca, agente) mediante programación.
Esta guía le guiará:
- Qué requisitos previos deben cumplirse.
- Los puntos finales de la gestión de marcas: qué hacen, qué datos se necesitan.
- Los puntos finales de gestión de agentes: qué hacen y qué datos se necesitan.
- El flujo de trabajo completo de la incorporación: pasos, transiciones de estado.
Requisitos previos
Antes de empezar a utilizar los puntos de conexión de la API, asegúrate de que:
- Tienes una cuenta API de Vonage.
- Está autorizado a llamar a las API de Gestión de Marcas y Gestión de Agentes.
- Ya has recopilado todos los metadatos necesarios sobre la marca o el agente: nombre de la marca, logotipo, imagen de cabecera, página web, política de privacidad, condiciones de uso, información de correo electrónico y de visualización, etc.
- Conoces los requisitos de verificación vigentes en el territorio al que te diriges (por ejemplo, en EE. UU.).
Componentes clave de la API
Hay dos entidades principales:
- Marca: representa a tu organización (empresa, identidad de marca).
- Agente: representa la identidad de la marca en el envío de mensajes (nombre, logotipo, color, etc.).
Puntos finales de la gestión de marcas
Estos puntos finales se utilizan para crear o actualizar la entidad Marca.
| Funcionamiento | Método y ruta HTTP | Propósito |
|---|---|---|
| Lista de marcas | [OBTENER] https://api.nexmo.com/v1/channel-manager/rcs/brands |
Enumere todas las marcas de su Account. |
| Crear marca | POST https://api.nexmo.com/v1/channel-manager/rcs/brands |
Crear una nueva marca. |
| Actualizar marca | PATCH https://api.nexmo.com/v1/channel-manager/rcs/brands/:brand_id |
Modificar el nombre de la marca. |
| Borrar marca | [ELIMINAR] https://api.nexmo.com/v1/channel-manager/rcs/brands/:brand_id |
Eliminar una marca RCS existente. |
Puntos finales de gestión de agentes
Estos puntos finales se utilizan para crear agentes bajo una marca. Un agente es lo que se necesita para enviar mensajes RCS en nombre de la marca.
| Funcionamiento | Método y ruta HTTP | Propósito |
|---|---|---|
| Lista de agentes | [OBTENER] https://api.nexmo.com/v1/channel-manager/rcs/agents |
Listar todos los agentes bajo su Account o bajo una marca. |
| Crear agente | POST https://api.nexmo.com/v1/channel-manager/rcs/agents |
Registrar a un agente para una marca determinada, lo que incluye facilitar los elementos de marca (logotipo, banner), la información de visualización, el número de teléfono, la descripción, etc. |
| Agente | [OBTENER] https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id |
Obtener los metadatos del agente, su estado, la marca asociada, etc. |
| Agente de actualización | PUT https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id |
Cambie los metadatos del agente, las imágenes, posiblemente el número de teléfono y la descripción. Algunos campos pueden bloquearse tras la verificación. |
| Agente de actualización parcial | PATCH https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id |
Actualizar parcialmente un Agente RCS existente. |
| Obtener transportistas | [OBTENER] https://api.nexmo.com/v1/channel-manager/rcs/metadata/carriers |
Obtener la lista de transportistas. |
| Añadir operadores al agente | POST https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/carriers |
Añadir operadores a un agente RCS ya existente. |
| Añadir dispositivos de prueba al agente | POST https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/test-devices |
Añadir dispositivos de prueba a un agente RCS ya existente. |
| Quitar el dispositivo de prueba del agente | [ELIMINAR] https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/test-devices/:test_device_id |
Eliminar un dispositivo de prueba de un Agente RCS existente. |
Flujo de trabajo de incorporación
Este es el proceso típico de incorporación para configurar los puntos de conexión de la marca y del agente:
Empiece por crear una marca con el POST /v1/channel-manager/rcs/brands punto final. En esta solicitud, usted registra el nombre de su marca. Una vez creada la marca, la API devuelve un archivo brand_id que debes tener en cuenta en todos los pasos siguientes.
Cuando la marca ya existe, se crea un agente llamando a la función POST /v1/channel-manager/rcs/agents punto final. El agente representa el perfil de cara al cliente que enviará mensajes RCS en nombre de su marca. En esta solicitud, usted proporciona el brand_id junto con el nombre, la descripción, las imágenes y los datos de contacto del agente. La API responde con un agent_idque se convierte en el identificador para todas las operaciones sobre el agente.
Añada números de prueba utilizando el botón POST https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/test-devices punto final. Estas cifras te permiten probar la experiencia del agente antes de su puesta en marcha.
Inicia el agente utilizando PUT /v1/channel-manager/rcs/agents/:agent_id o utilizando PATCH /v1/channel-manager/rcs/agents/:agent_id y proporcionando información pertinente.
Nota: Solo puedes editar el agente hasta que se haya puesto en marcha. Una vez puesto en marcha, ponte en contacto con tu gestor de cuentas o con el servicio de asistencia de Vonage para realizar cualquier modificación adicional.
Seleccione los transportistas que deben alojar el agente llamando a la función POST /v1/channel-manager/rcs/agents/{agentId}/carriers endpoint. En esta solicitud, se especifica la lista de ID de operador en la que desea que se lance el agente. Puede revisar la configuración del operador con GET /v1/channel-manager/rcs/carriers.
Cuando los transportistas y Google aprueban el agente, esto no hace que el agente esté inmediatamente disponible en producción. En su lugar, envía la solicitud para una revisión interna por parte de nuestro equipo de operaciones, que trabajará con los transportistas para completar el lanzamiento. El proceso suele durar entre 4 y 8 semanas, tras las cuales podrás empezar a utilizar el agente como remitente en la Messages API para enviar mensajes RCS a tus clientes.
Mantenimiento continuo
Si es necesario actualizar algunos metadatos (logotipo, descripción), compruebe qué campos son editables tras la verificación o póngase en contacto con su gestor de Account. Algunos pueden estar bloqueados.
Estados de los agentes
| Estado | Descripción |
|---|---|
| DRAFT | Estado temporal durante un breve periodo tras el envío de la información del agente, mientras se inician los procesos de fondo. El registro del agente está incompleto durante esta fase. |
| CREATED | El registro del agente está completo y almacenado de forma segura en el sistema. |
| PENDING | El agente ha sido sometido a verificación. Los transportistas y Google están revisando la marca. El agente no estará disponible para su lanzamiento hasta que supere todas las comprobaciones. |
| REJECTED | El agente no ha superado el proceso de verificación y no se puede iniciar. |
| LAUNCHED | El agente ha superado todas las comprobaciones de verificación y ha recibido la aprobación de los operadores y de Google. Ahora está activo y puede utilizarse como remitente en la Messages API para conversaciones RCS. |