SMS para aplicaciones (versión preliminar)
El conector retarus SMS permite a las organizaciones automatizar y entregar mensajes de texto de forma confiable desde flujos de trabajo de Microsoft. Úselo para enviar trabajos sms, consultar el estado del trabajo, recuperar los resultados de entrega por destinatario y obtener los detalles de la versión de la API. Se requieren una cuenta activa de Retarus y credenciales de API válidas. Para obtener una cuenta de prueba para este servicio o cualquiera de nuestros otros servicios sms, póngase en contacto con Retarus.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Retarus |
| URL | https://www.retarus.com/ |
| Correo Electrónico | info@retarus.com |
| Metadatos del conector | |
|---|---|
| Publicador | retarus GmbH |
| Sitio web | https://www.retarus.com/ |
| Directiva de privacidad | https://www.retarus.com/data-privacy-policy/ |
| Categorías | Comunicación; Marketing |
Retarus SMS
El conector retarus SMS permite a las organizaciones automatizar el envío de mensajes de texto y realizar un seguimiento de su estado de entrega.
Proporciona funcionalidades de comunicación seguras y confiables para flujos de trabajo empresariales que requieren entrega de SMS a gran escala. Puede usar el conector para enviar mensajes, comprobar el estado de los trabajos, recuperar los resultados de entrega por destinatario y acceder a la información de la versión de la API.
Prerrequisitos
Una cuenta de SMS retarus con credenciales de API válidas. Una cuenta de Azure y una suscripción con privilegios administrativos. Operaciones admitidas El conector admite las siguientes operaciones:
- Enviar un trabajo de SMS: envíe uno o varios mensajes SMS a uno o varios destinatarios.
- Obtener el estado del trabajo: recupere el estado y los identificadores de SMS de un trabajo enviado previamente.
- Obtener todos los trabajos para los criterios especificados: recupere una lista de identificadores de trabajo filtrados por intervalo de tiempo u otros criterios.
- Obtener el estado de todos los destinatarios de un trabajo: recupere los resultados de entrega de cada destinatario de un trabajo sms específico.
- Obtenga la información de versión: recupere la información de la versión actual de la API de SMS de Retarus.
Instrucciones de implementación
Para usar este conector:
- configúrelo en el entorno como un conector personalizado.
- Proporcione las credenciales válidas de la API de Retarus asociadas a su cuenta de Retarus.
- Asegúrese de que la cuenta está aprovisionada para SMS-for-Applications para que pueda enviar trabajos de SMS y consultar la información del trabajo expuesta por la API.
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| nombre de usuario | securestring | El nombre de usuario de esta API | Cierto |
| contraseña | securestring | La contraseña de esta API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Envío de un trabajo de SMS |
Esta operación envía uno o varios mensajes SMS con uno o varios destinatarios cada uno. La respuesta contiene el identificador de trabajo (jobId) del nuevo trabajo sms. |
| Obtención de la información de versión |
Esta operación recupera la información de versión actual de la API. |
| Obtención de todos los trabajos para los criterios especificados |
Esta operación recupera una lista de identificadores de trabajo durante un período de tiempo especificado y los filtros opcionales. |
| Obtención del estado del trabajo |
Esta operación recupera el estado del trabajo y la lista de identificadores SMS del trabajo. Para obtener el estado de mensaje individual de todos los mensajes de un trabajo, use el punto de conexión sms con el parámetro jobId correspondiente. |
| Obtener el estado de todos los destinatarios de un trabajo |
Esta operación recupera el estado de mensaje individual para todos los destinatarios de un trabajo específico. |
Envío de un trabajo de SMS
Esta operación envía uno o varios mensajes SMS con uno o varios destinatarios cada uno. La respuesta contiene el identificador de trabajo (jobId) del nuevo trabajo sms.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
src
|
src | string |
Identificador del remitente que se muestra al destinatario. |
|
|
encoding
|
encoding | string | ||
|
billcode
|
billcode | string |
Máx. 70 caracteres. |
|
|
statusRequested
|
statusRequested | boolean |
Notificación de entrega solicitada. |
|
|
flash
|
flash | boolean | ||
|
customerRef
|
customerRef | string |
Se recomienda un máximo de 64 caracteres. |
|
|
validityMin
|
validityMin | integer |
Validez del SMS en minutos. Cuando se usa 0, se usa el valor predeterminado del proveedor. De lo contrario, los valores deben estar entre 5 y 2880 minutos. |
|
|
maxParts
|
maxParts | integer |
Número máximo de elementos permitidos en un mensaje de varias partes. Los valores deben estar comprendidos entre 1 y 20. Los mensajes más largos se truncan. |
|
|
invalidCharacters
|
invalidCharacters | string |
Defina cómo controlar caracteres no válidos en SMS. |
|
|
QoS
|
qos | string |
Calidad del servicio. |
|
|
jobPeriod
|
jobPeriod | date-time |
Marca de tiempo para programar cuándo empezar a procesar el trabajo sms (iso-8601). |
|
|
duplicateDetection
|
duplicateDetection | boolean | ||
|
blackoutPeriods
|
blackoutPeriods | array of string | ||
|
texto
|
text | True | string |
Foo |
|
Dst
|
dst | True | string | |
|
customerRef
|
customerRef | string |
Se recomienda un máximo de 64 caracteres. Número de teléfono móvil del destinatario usado como valor predeterminado. |
|
|
blackoutPeriods
|
blackoutPeriods | array of string |
Devoluciones
- Body
- JobResponse
Obtención de la información de versión
Esta operación recupera la información de versión actual de la API.
Devoluciones
- Body
- VersionInfoResponse
Obtención de todos los trabajos para los criterios especificados
Esta operación recupera una lista de identificadores de trabajo durante un período de tiempo especificado y los filtros opcionales.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Devolver solo jobIDs
|
jobIdsOnly | True | boolean |
Devuelve solo los id. de trabajo. Actualmente solo se admite "true". |
|
Desde marca de tiempo
|
fromTs | date-time |
Desde la marca de tiempo (ISO-8601). El intervalo entre fromTs y toT puede ser un máximo de 30 días. |
|
|
Para la marca de tiempo
|
toTs | date-time |
Marca de tiempo (ISO-8601). El intervalo entre fromTs y toT puede ser un máximo de 30 días. |
|
|
Devolver solo trabajos abiertos
|
open | boolean |
Devuelve solo trabajos abiertos. |
|
|
Desplazar
|
offset | integer |
Parámetro usado para la paginación. Recupere un subconjunto de registros a partir del valor de desplazamiento. |
|
|
Resultados máximos devueltos
|
limit | integer |
Limite el número de resultados devueltos. El valor debe estar comprendido entre 0 y 1000. |
Devoluciones
- response
- array of JobReport
Obtención del estado del trabajo
Esta operación recupera el estado del trabajo y la lista de identificadores SMS del trabajo. Para obtener el estado de mensaje individual de todos los mensajes de un trabajo, use el punto de conexión sms con el parámetro jobId correspondiente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del trabajo
|
jobId | True | string |
Identificador de trabajo de Retarus. |
Devoluciones
- Body
- JobReport
Obtener el estado de todos los destinatarios de un trabajo
Esta operación recupera el estado de mensaje individual para todos los destinatarios de un trabajo específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del trabajo
|
jobId | True | string |
Identificador de trabajo de Retarus. |
Devoluciones
- response
- array of RecipientReport
Definiciones
JobResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
jobId
|
jobId | string |
JobReport
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
jobId
|
jobId | string | |
|
src
|
src | string |
Id. de remitente. |
|
encoding
|
encoding | string | |
|
billcode
|
billcode | string | |
|
statusRequested
|
statusRequested | boolean |
Notificación de entrega solicitada. |
|
flash
|
flash | boolean | |
|
validityMin
|
validityMin | integer |
Validez del SMS en minutos. |
|
customerRef
|
customerRef | string |
Se recomienda un máximo de 64 caracteres. |
|
QoS
|
qos | string |
Calidad del servicio. |
|
receiptT
|
receiptTs | date-time |
Marca de tiempo que indica cuándo recibió el trabajo Retarus (iso-8601). |
|
finishedTs
|
finishedTs | date-time |
Marca de tiempo que indica cuándo el SMS recibió su estado final (iso-8601). |
|
recipientIds
|
recipientIds | array of string |
RecipientReport
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
smsId
|
smsId | string | |
|
Dst
|
dst | string |
Número de teléfono móvil del destinatario. |
|
processStatus
|
processStatus | string |
Estado del proceso actual (consulte Códigos de estado de salida de SMS). |
|
estado
|
status | string |
Estado (consulte Códigos de estado de salida de SMS). |
|
customerRef
|
customerRef | string |
Se recomienda un máximo de 64 caracteres. |
|
motivo
|
reason | string | |
|
sentTs
|
sentTs | date-time |
Marca de tiempo cuando se envió el SMS (iso-8601). |
|
finishedTs
|
finishedTs | date-time |
Marca de tiempo que indica cuándo el SMS recibió su estado final (iso-8601). |
VersionInfoResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
buildNumber
|
buildNumber | integer | |
|
buildTimestamp
|
buildTimestamp | string | |
|
majorVersion
|
majorVersion | integer | |
|
minorVersion
|
minorVersion | integer | |
|
versionInfo
|
versionInfo | string | |
|
Mensaje
|
message | string |