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 el envío de mensajes RCS, es imprescindible registrar un agente con cada operador de red al que desee enviar mensajes RCS. El agente es, por así decirlo, el remitente verificado del RCS y está diseñado en su CI.
- 1
Registrar agentes
El proceso de registro actualmente solo puede realizarse manualmente. Envíe el formulario en nuestra página de producto de RCS para poder comenzar con RCS. Después, nos pondremos en contacto con usted de inmediato para solicitar algunos datos necesarios para la configuración del agente.
- 2
Integrar API de RCS
Una vez que su agente esté configurado, puede comenzar directamente con la implementación de la API.
- 3
Probar RCS
Verifique su integración a fondo. En este momento, solo puede utilizar los números de prueba registrados para el agente.
- 4
Solicitar aprobación
Una vez que haya implementado RCS y lo haya probado de manera suficiente y exitosa, podemos solicitar la aprobación del agente con los operadores de red deseados. Este proceso generalmente toma unos pocos días hábiles y a menudo está asociado con consultas adicionales.
- 5
Enviar RCS 🚀
¡Está listo para comenzar a enviar mensajes RCS!
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 SMS 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 SMS. 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": "Hier ist der Text der SMS", "from": "Absender" }
curl -X POST "https://gateway.seven.io/api/rcs/messages" \
-H "X-Api-Key: IHR_API_SCHLÜSSEL" \
-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",
// ...
}
]
}
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.
Parámetros de ruta
- Name
ID del mensaje- Type
- string
- Description
La ID del mensaje que se debe eliminar.
Solicitud
curl -X DELETE "https://gateway.seven.io/api/rcs/messages/123456" \
-H "X-Api-Key: SU_CLAVE_API"
Respuesta
{
"success": true
}
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á escribiendoREAD- El mensaje enviado por el usuario ha sido leído
Anfrage
curl -X POST "https://gateway.seven.io/api/rcs/events" \
-H "X-Api-Key: IHR_API_SCHLÜSSEL" \
-d "to=49176123456789" \
-d "event=IS_TYPING" \
-d "from=myfancyagent"
Antwort
{
"success": true
}