SMS para aplicativos (versão prévia)
O conector de SMS do Retarus permite que as organizações automatizem e forneçam mensagens de texto de forma confiável dos fluxos de trabalho da Microsoft. Use-o para enviar trabalhos sms, consultar o status do trabalho, recuperar resultados de entrega por destinatário e obter detalhes da versão da API. Uma conta do Retarus ativa e credenciais de API válidas são necessárias. Para obter uma conta de teste para esse serviço ou qualquer um de nossos outros serviços de SMS, entre em contato com o Retarus.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Retarus |
| URL | https://www.retarus.com/ |
| info@retarus.com |
| Metadados do conector | |
|---|---|
| Publicador | retarus GmbH |
| Site | https://www.retarus.com/ |
| Política de privacidade | https://www.retarus.com/data-privacy-policy/ |
| Categorias | Comunicação; Marketing |
Retarus SMS
O conector de SMS do Retarus permite que as organizações automatizem o envio de mensagens de texto e acompanhem seu status de entrega.
Ele fornece recursos de comunicação seguros e confiáveis para fluxos de trabalho de negócios que exigem entrega de SMS em larga escala. Você pode usar o conector para enviar mensagens, verificar o status dos trabalhos, recuperar resultados de entrega por destinatário e acessar informações de versão da API.
Pré-requisitos
Uma conta de SMS do Retarus com credenciais de API válidas. Uma conta e uma assinatura do Azure com privilégios administrativos. Operações com suporte O conector dá suporte às seguintes operações:
- Enviar um trabalho de SMS: envie uma ou mais mensagens SMS para um ou mais destinatários.
- Obtenha o status do trabalho: recupere o status e as IDs de SMS para um trabalho enviado anteriormente.
- Obtenha todos os trabalhos para os critérios fornecidos: recupere uma lista de IDs de trabalho filtradas por intervalo de tempo ou outros critérios.
- Obtenha o status de todos os destinatários de um trabalho: recupere os resultados de entrega para cada destinatário em um trabalho de SMS específico.
- Obtenha as informações de versão: recupere as informações de versão atuais da API de SMS do Retarus.
Instruções de implantação
Para usar este conector:
- configure-o em seu ambiente como um conector personalizado.
- Forneça credenciais válidas da API retarus associadas à sua conta do Retarus.
- Verifique se sua conta está provisionada para SMS-for-Applications para que você possa enviar trabalhos sms e consultar informações de trabalho expostas pela API.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| nome de usuário | secureString | O nome de usuário para esta api | Verdade |
| senha | secureString | A senha dessa api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Enviar um trabalho de SMS |
Esta operação envia uma ou mais mensagens SMS com um ou mais destinatários cada. A resposta contém a ID do trabalho (jobId) do novo trabalho de SMS. |
| Obter as informações de versão |
Essa operação recupera as informações de versão atuais da API. |
| Obter o status de todos os destinatários de um trabalho |
Esta operação recupera o status de mensagem individual para todos os destinatários de um trabalho específico. |
| Obter o status do trabalho |
Essa operação recupera o status do trabalho e a lista de IDs de SMS para o trabalho. Para obter o status da mensagem individual para todas as mensagens em um trabalho, use o ponto de extremidade SMS com o parâmetro jobId correspondente. |
| Obter todos os trabalhos para os critérios especificados |
Essa operação recupera uma lista de IDs de trabalho para um período de tempo especificado e quaisquer filtros opcionais. |
Enviar um trabalho de SMS
Esta operação envia uma ou mais mensagens SMS com um ou mais destinatários cada. A resposta contém a ID do trabalho (jobId) do novo trabalho de SMS.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
src
|
src | string |
A ID do Remetente exibida no destinatário. |
|
|
codificação
|
encoding | string | ||
|
billcode
|
billcode | string |
Max. 70 caracteres. |
|
|
statusRequested
|
statusRequested | boolean |
Notificação de entrega solicitada. |
|
|
flash
|
flash | boolean | ||
|
customerRef
|
customerRef | string |
Máximo recomendado de 64 caracteres. |
|
|
validityMin
|
validityMin | integer |
Validade do SMS em minutos. Quando 0 o valor padrão do provedor é usado. Caso contrário, os valores devem estar entre 5 e 2880 minutos. |
|
|
maxParts
|
maxParts | integer |
Máximo de partes permitidas em uma mensagem de várias partes. Os valores devem estar entre 1 e 20. Mensagens mais longas são truncadas. |
|
|
invalidCharacters
|
invalidCharacters | string |
Defina como lidar com caracteres inválidos no SMS. |
|
|
QoS
|
qos | string |
Qualidade do serviço. |
|
|
jobPeriod
|
jobPeriod | date-time |
Carimbo de data/hora para agendar quando começar a processar o trabalho de SMS (iso-8601). |
|
|
duplicateDetection
|
duplicateDetection | boolean | ||
|
blackoutPeriods
|
blackoutPeriods | array of string | ||
|
enviar SMS
|
text | True | string |
Foo |
|
Dst
|
dst | True | string | |
|
customerRef
|
customerRef | string |
Máximo recomendado de 64 caracteres. Número de telefone celular do destinatário usado como padrão. |
|
|
blackoutPeriods
|
blackoutPeriods | array of string |
Retornos
- Corpo
- JobResponse
Obter as informações de versão
Obter o status de todos os destinatários de um trabalho
Esta operação recupera o status de mensagem individual para todos os destinatários de um trabalho específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | string |
A ID do trabalho do Retarus. |
Retornos
- response
- array of RecipientReport
Obter o status do trabalho
Essa operação recupera o status do trabalho e a lista de IDs de SMS para o trabalho. Para obter o status da mensagem individual para todas as mensagens em um trabalho, use o ponto de extremidade SMS com o parâmetro jobId correspondente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | string |
A ID do trabalho do Retarus. |
Retornos
- Corpo
- JobReport
Obter todos os trabalhos para os critérios especificados
Essa operação recupera uma lista de IDs de trabalho para um período de tempo especificado e quaisquer filtros opcionais.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Retornar apenas jobIDs
|
jobIdsOnly | True | boolean |
Retornar somente jobIDs. Atualmente, há suporte apenas para "true". |
|
Do carimbo de data/hora
|
fromTs | date-time |
Do carimbo de data/hora (ISO-8601). O intervalo entre fromTs e toTs pode ser de no máximo 30 dias. |
|
|
Para carimbo de data/hora
|
toTs | date-time |
Para carimbo de data/hora (ISO-8601). O intervalo entre fromTs e toTs pode ser de no máximo 30 dias. |
|
|
Retornar somente trabalhos abertos
|
open | boolean |
Retornar somente trabalhos abertos. |
|
|
Offset
|
offset | integer |
Parâmetro usado para paginação. Recupere um subconjunto de registros começando com o valor de deslocamento. |
|
|
Resultados máximos retornados
|
limit | integer |
Número limite de resultados retornados. O valor deve estar entre 0 e 1000. |
Retornos
- response
- array of JobReport
Definições
JobResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
jobId
|
jobId | string |
JobReport
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
jobId
|
jobId | string | |
|
src
|
src | string |
ID do remetente. |
|
codificação
|
encoding | string | |
|
billcode
|
billcode | string | |
|
statusRequested
|
statusRequested | boolean |
Notificação de entrega solicitada. |
|
flash
|
flash | boolean | |
|
validityMin
|
validityMin | integer |
Validade do SMS em minutos. |
|
customerRef
|
customerRef | string |
Máximo recomendado de 64 caracteres. |
|
QoS
|
qos | string |
Qualidade do serviço. |
|
receiptTs
|
receiptTs | date-time |
Carimbo de data/hora que indica quando o trabalho foi recebido pelo Retarus (iso-8601). |
|
finishedTs
|
finishedTs | date-time |
Carimbo de data/hora indicando quando o SMS recebeu seu status final (iso-8601). |
|
recipientIds
|
recipientIds | array of string |
RecipientReport
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
smsId
|
smsId | string | |
|
Dst
|
dst | string |
Número de telefone celular do destinatário. |
|
processStatus
|
processStatus | string |
Status do processo atual (consulte códigos de status de saída de SMS). |
|
status
|
status | string |
Status (consulte códigos de status de saída de SMS). |
|
customerRef
|
customerRef | string |
Máximo recomendado de 64 caracteres. |
|
reason
|
reason | string | |
|
sentTs
|
sentTs | date-time |
Carimbo de data/hora quando o SMS foi enviado (iso-8601). |
|
finishedTs
|
finishedTs | date-time |
Carimbo de data/hora que indica quando o SMS recebeu seu status final (iso-8601). |
VersionInfoResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
buildNumber
|
buildNumber | integer | |
|
buildTimestamp
|
buildTimestamp | string | |
|
majorVersion
|
majorVersion | integer | |
|
minorVersion
|
minorVersion | integer | |
|
versionInfo
|
versionInfo | string | |
|
mensagem
|
message | string |