SMS para Candidaturas (Pré-visualização)
O conector SMS Retarus permite que as organizações automatizem e entreguem de forma fiável mensagens de texto a partir dos fluxos de trabalho da Microsoft. Use-o para submeter trabalhos por SMS, consultar o estado do trabalho, obter resultados de entrega por destinatário e obter detalhes da versão da API. É necessária uma conta Retarus ativa e credenciais válidas da API. Para obter uma conta de teste para este serviço ou para qualquer um dos nossos outros serviços de SMS, por favor contacte a Retarus.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - 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 Automatic , exceto as seguintes: - Governo dos EUA (CCG) - 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 | |
|---|---|
| Editora | retarus GmbH |
| Sítio Web | https://www.retarus.com/ |
| Política de privacidade | https://www.retarus.com/data-privacy-policy/ |
| Categorias | Comunicação; Comercialização |
Retarus SMS
O conector SMS Retarus permite às organizações automatizar o envio de mensagens de texto e acompanhar o seu estado de entrega.
Fornece capacidades de comunicação seguras e fiáveis para fluxos de trabalho empresariais que exigem entrega de SMS em larga escala. Pode usar o conector para enviar mensagens, verificar o estado dos trabalhos, recuperar resultados de entrega por destinatário e aceder à informação de versão da API.
Pré-requisitos
Uma conta SMS Retarus com credenciais de API válidas. Uma conta Azure e subscrição com privilégios administrativos. Operações Suportadas O conector suporta as seguintes operações:
- Enviar uma tarefa SMS: Enviar uma ou mais mensagens SMS a um ou mais destinatários.
- Obtenha o estado do emprego: Recupere o estado e os IDs SMS de um emprego previamente submetido.
- Obtenha todos os empregos para os critérios indicados: Recupere uma lista de IDs de emprego filtrados por intervalo temporal ou outros critérios.
- Obtenha o estado de todos os destinatários de uma tarefa: Recupere os resultados de entrega de cada destinatário numa tarefa SMS específica.
- Obtenha a informação da versão: Recupere a versão atual da API SMS do Retarus.
Instruções de implantação
Para usar este conector:
- Configure-o no seu ambiente como um conector personalizado.
- Forneça credenciais válidas da API Retarus associadas à sua conta Retarus.
- Certifique-se de que a sua conta está provisionada para SMS para Candidaturas, para que possa submeter tarefas por SMS e consultar informações de emprego expostas pela API.
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | 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.
Esta conexão não é compartilhável. Se o aplicativo avançado 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 utilizador | securestring | O nome de usuário para esta api | Verdade |
| palavra-passe | securestring | A senha para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Enviar uma tarefa por SMS |
Esta operação envia uma ou mais mensagens SMS com um ou mais destinatários cada. A resposta contém o ID do trabalho (jobId) do novo trabalho por SMS. |
| Obtenha a informação da versão |
Esta operação recupera a informação da versão atual da API. |
| Obtenha o estado do emprego |
Esta operação recupera o estado da tarefa e a lista de IDs SMS da tarefa. Para obter o estado individual das mensagens de todas as mensagens de um trabalho, use o endpoint SMS com o parâmetro jobId correspondente. |
| Obtenha o estatuto de todos os beneficiários de um emprego |
Esta operação recupera o estado individual da mensagem de todos os destinatários de uma tarefa específica. |
| Obtenha todos os empregos que cumpram os critérios indicados |
Esta operação recupera uma lista de IDs de trabalho para um período de tempo especificado e quaisquer filtros opcionais. |
Enviar uma tarefa por SMS
Esta operação envia uma ou mais mensagens SMS com um ou mais destinatários cada. A resposta contém o ID do trabalho (jobId) do novo trabalho por SMS.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
SRC
|
src | string |
O ID do Remetente era mostrado ao destinatário. |
|
|
codificação
|
encoding | string | ||
|
Código de Fatura
|
billcode | string |
Máx. 70 caracteres. |
|
|
EstadoSolicitado
|
statusRequested | boolean |
Notificação de entrega solicitada. |
|
|
flash
|
flash | boolean | ||
|
customerRef
|
customerRef | string |
Recomendado máximo 64 caracteres. |
|
|
validadeMin
|
validityMin | integer |
Validade do SMS em minutos. Quando 0 é utilizado o valor padrão do fornecedor. Caso contrário, os valores devem estar entre 5 e 2880 minutos. |
|
|
maxParts
|
maxParts | integer |
Número máximo de peças permitidas numa 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 em SMS. |
|
|
qos
|
qos | string |
Qualidade de Serviço. |
|
|
empregoPonto
|
jobPeriod | date-time |
Carimbo temporal para agendar quando começar a processar o Trabalho SMS (iso-8601). |
|
|
Deteção de duplicados
|
duplicateDetection | boolean | ||
|
BlackoutPeríodos
|
blackoutPeriods | array of string | ||
|
enviar SMS
|
text | True | string |
foo |
|
horário de verão
|
dst | True | string | |
|
customerRef
|
customerRef | string |
Recomendado máximo 64 caracteres. Número de telemóvel do destinatário usado por defeito. |
|
|
BlackoutPeríodos
|
blackoutPeriods | array of string |
Devoluções
- Body
- JobResponse
Obtenha a informação da versão
Obtenha o estado do emprego
Esta operação recupera o estado da tarefa e a lista de IDs SMS da tarefa. Para obter o estado individual das mensagens de todas as mensagens de um trabalho, use o endpoint SMS com o parâmetro jobId correspondente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | string |
O ID do emprego Retarus. |
Devoluções
- Body
- JobReport
Obtenha o estatuto de todos os beneficiários de um emprego
Esta operação recupera o estado individual da mensagem de todos os destinatários de uma tarefa específica.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | string |
O ID do emprego Retarus. |
Devoluções
- response
- array of RecipientReport
Obtenha todos os empregos que cumpram os critérios indicados
Esta operação recupera uma lista de IDs de trabalho para um período de tempo especificado e quaisquer filtros opcionais.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
JobIDs apenas de devolução
|
jobIdsOnly | True | boolean |
Devolver apenas os jobIDs. Atualmente, apenas o 'verdadeiro' é suportado. |
|
Do carimbo temporal
|
fromTs | date-time |
Do carimbo temporal (ISO-8601). O intervalo entre os fromTs e os toTs pode ser um máximo de 30 dias. |
|
|
Para carimbo temporal
|
toTs | date-time |
Para carimbo temporal (ISO-8601). O intervalo entre os fromTs e os toTs pode ser um máximo de 30 dias. |
|
|
Apenas devolução de vagas abertas
|
open | boolean |
Devolva apenas vagas abertas. |
|
|
Compensação
|
offset | integer |
Parâmetro usado para paginação. Recupere um subconjunto de registos começando pelo valor de deslocamento. |
|
|
Resultados máximos retornados
|
limit | integer |
Número limite de resultados devolvidos. O valor deve estar entre 0 e 1000. |
Devoluções
- response
- array of JobReport
Definições
JobResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
jobId
|
jobId | string |
Relatório de Emprego
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
jobId
|
jobId | string | |
|
SRC
|
src | string |
ID do remetente. |
|
codificação
|
encoding | string | |
|
Código de Fatura
|
billcode | string | |
|
EstadoSolicitado
|
statusRequested | boolean |
Notificação de entrega solicitada. |
|
flash
|
flash | boolean | |
|
validadeMin
|
validityMin | integer |
Validade do SMS em minutos. |
|
customerRef
|
customerRef | string |
Recomendado máximo 64 caracteres. |
|
qos
|
qos | string |
Qualidade de Serviço. |
|
ReceiptTs
|
receiptTs | date-time |
Carimbo temporal indicando quando o trabalho foi recebido pela Retarus (iso-8601). |
|
terminados
|
finishedTs | date-time |
Carimbo temporal indicando quando o SMS recebeu o seu estado final (iso-8601). |
|
RecipientesIds
|
recipientIds | array of string |
Relatório do Destinatário
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
smsId
|
smsId | string | |
|
horário de verão
|
dst | string |
Número de telemóvel do destinatário. |
|
Processo Estado
|
processStatus | string |
Estado atual do processo (ver Códigos de Estado de Saída do SMS). |
|
estado
|
status | string |
Estado (ver Códigos de Estado de Saída SMS). |
|
customerRef
|
customerRef | string |
Recomendado máximo 64 caracteres. |
|
razão
|
reason | string | |
|
sentTs
|
sentTs | date-time |
Carimbo temporal quando o SMS foi enviado (iso-8601). |
|
terminados
|
finishedTs | date-time |
Carimbo temporal que indica quando o SMS recebeu o seu estado final (iso-8601). |
VersionInfoResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Número de construção
|
buildNumber | integer | |
|
buildTimestamp
|
buildTimestamp | string | |
|
majorVersão
|
majorVersion | integer | |
|
versão menor
|
minorVersion | integer | |
|
versionInfo
|
versionInfo | string | |
|
mensagem
|
message | string |