RCS

La API de RCS de seven ofrece la posibilidad de integrar las potentes funciones de RCS en su aplicación, permitiendo así una comunicación rica e interactiva con sus usuarios. En esta documentación se describen en detalle los diferentes puntos finales, parámetros y funciones de la API de RCS. Descubra las diversas posibilidades que ofrece RCS para mejorar la mensajería, el intercambio de archivos, el uso compartido de ubicaciones y mucho más.

Para enviar mensajes RCS necesita su propio servicio RCS, también llamado agente. Es su remitente verificado con nombre de marca, logotipo y colores, y se activa para cada operador de red al que desee enviar mensajes RCS. El servicio lo configura usted mismo en el panel.

1
Crear un servicio RCS
En el panel, cree su servicio en Settings → Sender IDs: nombre de marca, logotipo, colores y datos de contacto. Encontrará una guía paso a paso en RCS inicio rápido.
2
Integrar API de RCS
Una vez creado su servicio, puede comenzar directamente con la implementación de la API.
3
Probar RCS
Registre sus números de prueba en el servicio. Hasta que el servicio esté activo, solo puede enviar mensajes RCS a estos números.
4
Activar el servicio
Envíe su servicio desde el panel para su activación con los operadores de red deseados. La verificación y la revisión por parte de los operadores pueden tardar varias semanas. Todos los requisitos se describen en Lanzar su servicio RCS.
5
Enviar RCS 🚀
¡Está listo y puede empezar a enviar mensajes RCS de inmediato!

POST/api/rcs/messages

Enviar RCS

Este punto final le permite enviar mensajes RCS a los usuarios. Antes de enviar un RCS, idealmente debería consultar las capacidades del número de teléfono para garantizar la mejor experiencia de usuario posible.

Parámetros

Name
to
Type
string
Description
El número de teléfono del destinatario para su mensaje RCS. Esto también puede ser un nombre de contacto o un nombre de grupo.
Name
text
Type
string
Description
Texto del mensaje RCS. Para enviar un mensaje RCS simple (sin imágenes, respuestas sugeridas, etc.), solo proporcione el texto puro del mensaje aquí. De lo contrario, use un objeto RCS.
Name
from
Type
string
Optional
Optional
Description
La ID única de su agente. Puede verla en la configuración de su cuenta. Si no se especifica, se utilizará el primer remitente compatible con RCS.
Name
delay
Type
timestamp
Optional
Optional
Description
Fecha/hora para el envío programado. Puede ser un Unix-Timestamp o una marca de tiempo en el formato yyyy-mm-dd hh:ii.
Name
ttl
Type
integer
Optional
Optional
Description
Indica la duración de validez del RCS en minutos. El valor predeterminado es 2880, es decir, 48 horas.
Name
label
Type
string
Optional
Optional
Description
Opcionalmente, asigne una etiqueta única a cada RCS para poder identificarlos en sus estadísticas. Máx. 100 caracteres, caracteres permitidos: a-z, A-Z, 0-9, .-_@.
Name
performance_tracking
Type
boolean
Optional
Optional
Description
Activar el seguimiento de clics y rendimiento para las URLs encontradas en el texto del RCS. Esto también activará el acortador de URL.
Name
foreign_id
Type
string
Optional
Optional
Description
Proporcione su propia ID para este mensaje. Recibirá el foreign_id de vuelta en los callbacks para informes de estado, etc. Máx. 64 caracteres, caracteres permitidos: a-z, A-Z, 0-9, .-_@.
Name
fallback
Type
enum | object
Optional
Optional
Description
Si no es posible enviar un RCS porque, por ejemplo, el dispositivo del destinatario no admite RCS, el mensaje puede enviarse automáticamente a través de un canal alternativo. Si no se especifica un fallback, este estará desactivado.
Envíe cualquiera de estos valores:
sms - Envía un SMS con el texto del mensaje RCS como contenido webview - Envía un SMS con un enlace a una vista web del mensaje RCS
O envíe un objeto JSON:
{ "type": "sms", "text": "Aquí está el texto del SMS.", "from": "Remitente" }

POST

/api/rcs/messages

curl -X POST "https://gateway.seven.io/api/rcs/messages" \
    -H "X-Api-Key: SU_CLAVE_API" \
    -d "text=Hello World!" \
    -d "to=49176123456789"

{
    "success": "100",
    "total_price": null,
    "balance": 3218.988,
    "debug": "false",
    "sms_type": "direct",
    "messages": [
        {
            "id": "77233319353",
            "sender": "myfancyagent",
            "recipient": "49176123456789",
            "text": "Hello World!",
            "encoding": "gsm",
            "label": null,
            "parts": 0,
            "udh": null,
            "is_binary": false,
            "price": 0,
            "channel": "RCS",
            "success": true,
            "error": null,
            "error_text": null
        },
        {
            "id": "77233319354",
            // ...
        }
    ]
}

DELETE/api/rcs/messages/:id

Eliminar RCS

Puede revocar un mensaje RCS que aún no ha sido entregado. Esta API devuelve inmediatamente una respuesta exitosa, independientemente de si el mensaje fue eliminado o no. Una revocación solo es posible si el dispositivo final tiene la capacidad REVOCATION.

No puede eliminar un mensaje RCS si ha especificado SMS o Rich SMS como respaldo.

Parámetros de ruta

Name
ID del mensaje
Type
string
Description
La ID del mensaje que se debe eliminar.

Solicitud

DELETE

/api/rcs/messages/123456

curl -X DELETE "https://gateway.seven.io/api/rcs/messages/123456" \
    -H "X-Api-Key: SU_CLAVE_API"

Respuesta

{
    "success": true
}

POST/api/rcs/events

Eventos

Envíe un evento a un número de teléfono para ofrecer a los usuarios una experiencia de conversación más auténtica. Después de recibir un mensaje, debe enviar el evento READ en un tiempo razonable y luego IS_TYPING en consecuencia.

Parámetros

Name
to
Type
string
Union
Description
El número de teléfono al que desea enviar el evento.
Name
msg_id
Type
string
Union
Description
El ID del RCS recibido al que desea enviar el evento.
Name
event
Type
enum
Description
El evento que se debe enviar. Puede tener uno de los siguientes valores:
Mostrar eventos
IS_TYPING - El agente está escribiendo READ - El mensaje enviado por el usuario ha sido leído

Solicitud

POST

/api/rcs/events

curl -X POST "https://gateway.seven.io/api/rcs/events" \
    -H "X-Api-Key: SU_CLAVE_API" \
    -d "to=49176123456789" \
    -d "event=IS_TYPING" \
    -d "from=myfancyagent"

Respuesta

{
    "success": true
}

GET/api/rcs/agents

Listar agentes

Este endpoint devuelve una lista de todos los agentes RCS disponibles en su cuenta, incluidos los agentes genéricos (de uso público). La respuesta incluye el estado actual, así como metadatos de cada agente.

Campos de respuesta

Name
agents
Type
array
Description
Array con todos los agentes RCS disponibles para su cuenta.
Name
agents[].id
Type
string
Description
El ID único del agente. Se utiliza como parámetro from al enviar un mensaje RCS.
Name
agents[].display_name
Type
string
Description
El nombre visible del agente para el destinatario.
Name
agents[].status
Type
enum
Description
El estado actual del agente. Valores posibles:
pending - El agente ha sido creado pero aún no ha sido enviado para revisión test - El agente solo puede enviar a los números de prueba configurados launched - El agente ha sido habilitado y puede enviar mensajes RCS en producción approved - El agente ha sido aprobado por los operadores de red
Name
agents[].logo_url
Type
string | null
Description
URL del logotipo del agente. Puede ser null o una cadena vacía si no se ha cargado ningún logotipo.
Name
agents[].created
Type
string
Description
Fecha de creación del agente en el formato yyyy-mm-dd hh:ii:ss.
Name
agents[].is_generic
Type
boolean
Description
Indica si se trata de un agente genérico. Los agentes genéricos son proporcionados por seven y pueden ser utilizados por varios clientes, en lugar de un agente creado exclusivamente para su cuenta.

Solicitud

GET

/api/rcs/agents

curl "https://gateway.seven.io/api/rcs/agents" \
    -H "X-Api-Key: SU_CLAVE_API"

Respuesta

{
    "agents": [
        {
            "id": "seven_demo_ja2E9Comde",
            "display_name": "seven.io Demo",
            "status": "launched",
            "logo_url": "https://agent-logos.storage.googleapis.com/_/lx8puyryRsdJQKrPufyE0ngg",
            "created": "2024-09-27 10:07:50",
            "is_generic": false
        },
        {
            "id": "werkstattdialogde_6C4d6081",
            "display_name": "WerkstattDialog.de",
            "status": "approved",
            "logo_url": null,
            "created": "2024-09-13 06:04:47",
            "is_generic": true
        }
    ]
}

RCS

Crear un servicio RCS

Integrar API de RCS

Probar RCS

Activar el servicio

Enviar RCS 🚀

Enviar RCS

Parámetros

Eliminar RCS

Parámetros de ruta

Solicitud

Respuesta

Eventos

Parámetros

Solicitud

Respuesta

Listar agentes

Campos de respuesta

Solicitud

Respuesta