O SMS Works (Independent Publisher) (versão prévia)
O SMS Works é um serviço de SMS de baixo custo para desenvolvedores com sede no Reino Unido. Você só é cobrado por mensagens de texto entregues.
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 | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Publicador | Troy Taylor |
| Site | https://thesmsworks.co.uk/ |
| Política de privacidade | https://thesmsworks.co.uk/privacy |
| Categorias | Communication |
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 |
|---|---|---|---|
| JWT Token | secureString | O Token JWT para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Agendar lote |
Agenda um lote de mensagens SMS a serem enviadas na data especificada. |
| Agendar mensagem |
Agenda uma mensagem SMS a ser enviada na data e hora especificada. |
| Cancelar lote agendado |
Cancela uma mensagem SMS agendada. |
| Cancelar mensagem agendada |
Cancela uma mensagem SMS agendada. |
| Enviar coleção de mensagens |
Envia uma coleção de mensagens SMS exclusivas. Os lotes podem conter até 5.000 mensagens por vez. |
| Enviar lote |
Envie uma única mensagem SMS para vários destinatários. |
| Enviar mensagem flash |
Envia uma mensagem flash SMS, que aparece na tela de bloqueio dos destinatários. |
| Enviar uma mensagem SMS |
Envia uma mensagem SMS com base em seus parâmetros. |
| Excluir mensagem |
Exclua a mensagem com a mensagem correspondente. |
| Obter a ID do cliente |
Retorna a ID do cliente para o chamador. |
| Obter créditos |
Retorna o número de créditos disponíveis atualmente na conta. |
| Obter mensagem |
Recupere uma mensagem registrada pela ID da mensagem. |
| Obter mensagens agendadas |
Retorna uma lista de mensagens agendadas de sua conta, compreendendo todas as mensagens agendadas nos últimos 3 meses e qualquer agendada para enviar no futuro. |
| Obter mensagens com falha |
Recupere mensagens com falha que correspondam aos critérios de pesquisa. |
| Obter mensagens não lidas |
Obtenha mensagens de entrada não lidas que correspondam aos critérios de pesquisa. |
| Pesquisar mensagens |
Recupere até 1.000 mensagens que correspondam aos critérios de pesquisa. |
| Recuperar mensagens em lote |
Recupere todas as mensagens em um lote com a ID do lote fornecida. |
Agendar lote
Agenda um lote de mensagens SMS a serem enviadas na data especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
smsMessage
|
smsMessage | True |
Propriedades da mensagem |
Retornos
- response
- ScheduledBatchResponse
Agendar mensagem
Agenda uma mensagem SMS a ser enviada na data e hora especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Remetente
|
sender | True | string |
O remetente da mensagem. Não deve ter mais de 11 caracteres para alfanuméricos ou 15 caracteres para IDs de remetente numérico. Sem espaços ou caracteres especiais. |
|
Destino
|
destination | True | string |
Número de telefone do destinatário |
|
Content
|
content | True | string |
Mensagem a ser enviada ao destinatário. O conteúdo pode ter até 1280 caracteres de comprimento. Mensagens de 160 caracteres ou menos são cobradas 1 crédito. Se sua mensagem tiver mais de 160 caracteres, ela será dividida em partes de 153 caracteres antes de ser enviada para o aparelho do destinatário, e você será cobrado 1 crédito por cada 153 caracteres. As mensagens enviadas para números registrados fora do Reino Unido normalmente serão cobradas créditos duplos, mas para determinados países podem ser cobradas frações de créditos (por exemplo, 2,5). Entre em contato conosco para obter taxas para cada país. |
|
URL do Relatório de Entrega
|
deliveryreporturl | string |
A URL para a qual devemos ENVIAR relatórios de entrega para esta mensagem. Se nenhum for especificado, usaremos a URL do relatório de entrega global que você configurou na página da sua conta. |
|
|
Cronograma
|
schedule | string |
Data em que enviar a mensagem. Isso só é usado pelo serviço de mensagem/agendamento e pode ser deixado vazio para outros serviços. |
|
|
Etiqueta
|
tag | string |
Um rótulo de identificação para a mensagem, que você pode usar para filtrar e relatar as mensagens enviadas posteriormente. Ideal para campanhas. Um máximo de 280 caracteres. |
|
|
TTL
|
ttl | number |
O número opcional de minutos antes que o relatório de entrega seja excluído. Optional. Omita para impedir a exclusão do relatório de entrega. |
|
|
Email de resposta
|
responseemail | array of string |
Uma lista opcional de endereços de email para o qual encaminhar respostas para essa mensagem específica. Um número de resposta do SMS Works é necessário para usar esse recurso. |
|
|
Metadados
|
Metadata | object | ||
|
Validade
|
validity | number |
O número opcional de minutos para tentar a entrega antes que a mensagem seja marcada como EXPIRADA. Optional. O padrão é 2880 minutos. |
Retornos
- response
- array of ScheduledMessageResponse
Cancelar lote agendado
Cancela uma mensagem SMS agendada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Lote
|
batchid | True | string |
A ID do lote que você gostaria de retornar |
Retornos
- response
- CancelledMessageResponse
Cancelar mensagem agendada
Cancela uma mensagem SMS agendada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da mensagem
|
messageid | True | string |
A ID da mensagem que você gostaria que retornasse |
Retornos
- response
- CancelledMessageResponse
Enviar coleção de mensagens
Envia uma coleção de mensagens SMS exclusivas. Os lotes podem conter até 5.000 mensagens por vez.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
messages
|
messages | True |
Uma matriz de mensagens |
Retornos
- response
- BatchMessageResponse
Enviar lote
Envie uma única mensagem SMS para vários destinatários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
smsMessage
|
smsMessage | True |
Propriedades da mensagem |
Retornos
- response
- BatchMessageResponse
Enviar mensagem flash
Envia uma mensagem flash SMS, que aparece na tela de bloqueio dos destinatários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Remetente
|
sender | True | string |
O remetente da mensagem. Não deve ter mais de 11 caracteres para alfanuméricos ou 15 caracteres para IDs de remetente numérico. Sem espaços ou caracteres especiais. |
|
Destino
|
destination | True | string |
Número de telefone do destinatário |
|
Content
|
content | True | string |
Mensagem a ser enviada ao destinatário. O conteúdo pode ter até 1280 caracteres de comprimento. Mensagens de 160 caracteres ou menos são cobradas 1 crédito. Se sua mensagem tiver mais de 160 caracteres, ela será dividida em partes de 153 caracteres antes de ser enviada para o aparelho do destinatário, e você será cobrado 1 crédito por cada 153 caracteres. As mensagens enviadas para números registrados fora do Reino Unido normalmente serão cobradas créditos duplos, mas para determinados países podem ser cobradas frações de créditos (por exemplo, 2,5). Entre em contato conosco para obter taxas para cada país. |
|
URL do Relatório de Entrega
|
deliveryreporturl | string |
A URL para a qual devemos ENVIAR relatórios de entrega para esta mensagem. Se nenhum for especificado, usaremos a URL do relatório de entrega global que você configurou na página da sua conta. |
|
|
Cronograma
|
schedule | string |
Data em que enviar a mensagem. Isso só é usado pelo serviço de mensagem/agendamento e pode ser deixado vazio para outros serviços. |
|
|
Etiqueta
|
tag | string |
Um rótulo de identificação para a mensagem, que você pode usar para filtrar e relatar as mensagens enviadas posteriormente. Ideal para campanhas. Um máximo de 280 caracteres. |
|
|
TTL
|
ttl | number |
O número opcional de minutos antes que o relatório de entrega seja excluído. Optional. Omita para impedir a exclusão do relatório de entrega. |
|
|
Email de resposta
|
responseemail | array of string |
Uma lista opcional de endereços de email para o qual encaminhar respostas para essa mensagem específica. Um número de resposta do SMS Works é necessário para usar esse recurso. |
|
|
Metadados
|
Metadata | object | ||
|
Validade
|
validity | number |
O número opcional de minutos para tentar a entrega antes que a mensagem seja marcada como EXPIRADA. Optional. O padrão é 2880 minutos. |
Retornos
- response
- SendMessageResponse
Enviar uma mensagem SMS
Envia uma mensagem SMS com base em seus parâmetros.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Remetente
|
sender | True | string |
O remetente da mensagem. Não deve ter mais de 11 caracteres para alfanuméricos ou 15 caracteres para IDs de remetente numérico. Sem espaços ou caracteres especiais. |
|
Destino
|
destination | True | string |
Número de telefone do destinatário |
|
Content
|
content | True | string |
Mensagem a ser enviada ao destinatário. O conteúdo pode ter até 1280 caracteres de comprimento. Mensagens de 160 caracteres ou menos são cobradas 1 crédito. Se sua mensagem tiver mais de 160 caracteres, ela será dividida em partes de 153 caracteres antes de ser enviada para o aparelho do destinatário, e você será cobrado 1 crédito por cada 153 caracteres. As mensagens enviadas para números registrados fora do Reino Unido normalmente serão cobradas créditos duplos, mas para determinados países podem ser cobradas frações de créditos (por exemplo, 2,5). Entre em contato conosco para obter taxas para cada país. |
|
URL do Relatório de Entrega
|
deliveryreporturl | string |
A URL para a qual devemos ENVIAR relatórios de entrega para esta mensagem. Se nenhum for especificado, usaremos a URL do relatório de entrega global que você configurou na página da sua conta. |
|
|
Cronograma
|
schedule | string |
Data em que enviar a mensagem. Isso só é usado pelo serviço de mensagem/agendamento e pode ser deixado vazio para outros serviços. |
|
|
Etiqueta
|
tag | string |
Um rótulo de identificação para a mensagem, que você pode usar para filtrar e relatar as mensagens enviadas posteriormente. Ideal para campanhas. Um máximo de 280 caracteres. |
|
|
TTL
|
ttl | number |
O número opcional de minutos antes que o relatório de entrega seja excluído. Optional. Omita para impedir a exclusão do relatório de entrega. |
|
|
Email de resposta
|
responseemail | array of string |
Uma lista opcional de endereços de email para o qual encaminhar respostas para essa mensagem específica. Um número de resposta do SMS Works é necessário para usar esse recurso. |
|
|
Metadados
|
Metadata | object | ||
|
Validade
|
validity | number |
O número opcional de minutos para tentar a entrega antes que a mensagem seja marcada como EXPIRADA. Optional. O padrão é 2880 minutos. |
Retornos
- response
- SendMessageResponse
Excluir mensagem
Exclua a mensagem com a mensagem correspondente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da mensagem
|
messageid | True | string |
A ID da mensagem que você gostaria que retornasse |
Retornos
- response
- DeletedMessageResponse
Obter a ID do cliente
Obter créditos
Obter mensagem
Recupere uma mensagem registrada pela ID da mensagem.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da mensagem
|
messageid | True | string |
A ID da mensagem que você gostaria que retornasse |
Retornos
- response
- MessageResponse
Obter mensagens agendadas
Retorna uma lista de mensagens agendadas de sua conta, compreendendo todas as mensagens agendadas nos últimos 3 meses e qualquer agendada para enviar no futuro.
Retornos
detalhes de uma mensagem agendada para ser enviada em uma data e hora especificadas
- response
- ScheduledMessagesResponse
Obter mensagens com falha
Recupere mensagens com falha que correspondam aos critérios de pesquisa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
consulta
|
query | True |
Retornos
- response
- array of MessageResponse
Obter mensagens não lidas
Obtenha mensagens de entrada não lidas que correspondam aos critérios de pesquisa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
consulta
|
query | True |
Retornos
- response
- array of MessageResponse
Pesquisar mensagens
Recupere até 1.000 mensagens que correspondam aos critérios de pesquisa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
consulta
|
query | True |
Retornos
- response
- array of MessageResponse
Recuperar mensagens em lote
Recupere todas as mensagens em um lote com a ID do lote fornecida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Lote
|
batchid | True | string |
A ID do lote que você gostaria de retornar |
Retornos
- response
- array of MessageResponse
Definições
TestResponse
CreditsResponse
ScheduledMessagesResponse
detalhes de uma mensagem agendada para ser enviada em uma data e hora especificadas
detalhes de uma mensagem agendada para ser enviada em uma data e hora especificadas