The SMS Works (Editora Independente) (Pré-visualização)
O SMS Works é um serviço de SMS de baixo custo para desenvolvedores baseados no Reino Unido. Você só é cobrado pelas mensagens de texto entregues.
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) |
| Automatize o poder | 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 | Troia Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Editora | Troia Taylor |
| Sítio Web | https://thesmsworks.co.uk/ |
| Política de privacidade | https://thesmsworks.co.uk/privacy |
| Categorias | Communication |
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 |
|---|---|---|---|
| JWT Token | securestring | O token JWT 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
| 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é 5000 mensagens de cada 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 nos seus parâmetros. |
| Excluir mensagem |
Exclua a mensagem com o messageid correspondente. |
| Lote agendado |
Programa um lote de mensagens SMS para serem enviadas na data especificada. |
| Mensagem de agendamento |
Programa uma mensagem SMS para ser enviada na data-hora que você especificar. |
| Obter créditos |
Devolve o número de créditos atualmente disponíveis na conta. |
| Obter ID de cliente |
Retorna o ID do cliente para o chamador. |
| Obter mensagens com falha |
Recupere mensagens com falha que correspondam aos seus critérios de pesquisa. |
| Pesquisar mensagens |
Recupere até 1000 mensagens que correspondam aos seus critérios de pesquisa. |
| Receber mensagem |
Recupere uma mensagem registrada pelo ID da mensagem. |
| Receber mensagens agendadas |
Devolve uma lista de mensagens agendadas a partir da sua conta, incluindo quaisquer mensagens agendadas nos últimos 3 meses e quaisquer mensagens agendadas para enviar no futuro. |
| Receber mensagens não lidas |
Obtenha mensagens recebidas não lidas que correspondam aos seus critérios de pesquisa. |
| Recuperar mensagens em lote |
Recupere todas as mensagens em um lote com o ID de lote fornecido. |
Cancelar lote agendado
Cancela uma mensagem SMS agendada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do lote
|
batchid | True | string |
O ID do lote que você gostaria de devolver |
Devoluções
- response
- CancelledMessageResponse
Cancelar mensagem agendada
Cancela uma mensagem SMS agendada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da mensagem
|
messageid | True | string |
O ID da mensagem que você gostaria de retornar |
Devoluções
- response
- CancelledMessageResponse
Enviar coleção de mensagens
Envia uma coleção de mensagens SMS exclusivas. Os lotes podem conter até 5000 mensagens de cada vez.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
messages
|
messages | True |
Uma matriz de mensagens |
Devoluções
- response
- BatchMessageResponse
Enviar lote
Envie uma única mensagem SMS para vários destinatários.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
smsMessage
|
smsMessage | True |
Propriedades da mensagem |
Devoluções
- response
- BatchMessageResponse
Enviar mensagem flash
Envia uma mensagem flash SMS, que aparece na tela de bloqueio dos destinatários.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Remetente
|
sender | True | string |
O remetente da mensagem. Não deve ter mais de 11 caracteres para os IDs alfanuméricos ou 15 caracteres para os IDs numéricos do remetente. Sem espaços ou caracteres especiais. |
|
Destino
|
destination | True | string |
Número de telefone do destinatário |
|
Content
|
content | True | string |
Mensagem a enviar ao destinatário. O conteúdo pode ter até 1280 caracteres. Mensagens de 160 caracteres ou menos são cobradas 1 crédito. Se a 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 para cada 153 caracteres. As mensagens enviadas para números registados fora do Reino Unido serão normalmente cobradas créditos em dobro, mas para certos países poderão ser cobradas frações de créditos (por exemplo, 2.5). Entre em contato conosco para saber as tarifas para cada país. |
|
URL do Relatório de Entrega
|
deliveryreporturl | string |
O url para o qual devemos POST relatórios de entrega para esta mensagem. Se nenhum for especificado, usaremos o URL do relatório de entrega global que você configurou na página da sua conta. |
|
|
Schedule
|
schedule | string |
Data de envio da mensagem. Isso só é usado pelo serviço de mensagem/agendamento e pode ser deixado vazio para outros serviços. |
|
|
Tag
|
tag | string |
Uma etiqueta de identificação para a mensagem, que pode utilizar para filtrar e comunicar as mensagens que enviou posteriormente. Ideal para campanhas. Um máximo de 280 caracteres. |
|
|
TTL
|
ttl | number |
O número opcional de minutos antes do relatório de entrega é excluído. Opcional. Omitir para impedir a exclusão do relatório de entrega. |
|
|
E-mail de resposta
|
responseemail | array of string |
Uma lista opcional de endereços de e-mail para os quais encaminhar respostas a esta 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 EXPIRADO. Opcional. O padrão é 2880 minutos. |
Devoluções
- response
- SendMessageResponse
Enviar uma mensagem SMS
Envia uma mensagem SMS com base nos seus parâmetros.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Remetente
|
sender | True | string |
O remetente da mensagem. Não deve ter mais de 11 caracteres para os IDs alfanuméricos ou 15 caracteres para os IDs numéricos do remetente. Sem espaços ou caracteres especiais. |
|
Destino
|
destination | True | string |
Número de telefone do destinatário |
|
Content
|
content | True | string |
Mensagem a enviar ao destinatário. O conteúdo pode ter até 1280 caracteres. Mensagens de 160 caracteres ou menos são cobradas 1 crédito. Se a 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 para cada 153 caracteres. As mensagens enviadas para números registados fora do Reino Unido serão normalmente cobradas créditos em dobro, mas para certos países poderão ser cobradas frações de créditos (por exemplo, 2.5). Entre em contato conosco para saber as tarifas para cada país. |
|
URL do Relatório de Entrega
|
deliveryreporturl | string |
O url para o qual devemos POST relatórios de entrega para esta mensagem. Se nenhum for especificado, usaremos o URL do relatório de entrega global que você configurou na página da sua conta. |
|
|
Schedule
|
schedule | string |
Data de envio da mensagem. Isso só é usado pelo serviço de mensagem/agendamento e pode ser deixado vazio para outros serviços. |
|
|
Tag
|
tag | string |
Uma etiqueta de identificação para a mensagem, que pode utilizar para filtrar e comunicar as mensagens que enviou posteriormente. Ideal para campanhas. Um máximo de 280 caracteres. |
|
|
TTL
|
ttl | number |
O número opcional de minutos antes do relatório de entrega é excluído. Opcional. Omitir para impedir a exclusão do relatório de entrega. |
|
|
E-mail de resposta
|
responseemail | array of string |
Uma lista opcional de endereços de e-mail para os quais encaminhar respostas a esta 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 EXPIRADO. Opcional. O padrão é 2880 minutos. |
Devoluções
- response
- SendMessageResponse
Excluir mensagem
Exclua a mensagem com o messageid correspondente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da mensagem
|
messageid | True | string |
O ID da mensagem que você gostaria de retornar |
Devoluções
- response
- DeletedMessageResponse
Lote agendado
Programa um lote de mensagens SMS para serem enviadas na data especificada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
smsMessage
|
smsMessage | True |
Propriedades da mensagem |
Devoluções
- response
- ScheduledBatchResponse
Mensagem de agendamento
Programa uma mensagem SMS para ser enviada na data-hora que você especificar.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Remetente
|
sender | True | string |
O remetente da mensagem. Não deve ter mais de 11 caracteres para os IDs alfanuméricos ou 15 caracteres para os IDs numéricos do remetente. Sem espaços ou caracteres especiais. |
|
Destino
|
destination | True | string |
Número de telefone do destinatário |
|
Content
|
content | True | string |
Mensagem a enviar ao destinatário. O conteúdo pode ter até 1280 caracteres. Mensagens de 160 caracteres ou menos são cobradas 1 crédito. Se a 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 para cada 153 caracteres. As mensagens enviadas para números registados fora do Reino Unido serão normalmente cobradas créditos em dobro, mas para certos países poderão ser cobradas frações de créditos (por exemplo, 2.5). Entre em contato conosco para saber as tarifas para cada país. |
|
URL do Relatório de Entrega
|
deliveryreporturl | string |
O url para o qual devemos POST relatórios de entrega para esta mensagem. Se nenhum for especificado, usaremos o URL do relatório de entrega global que você configurou na página da sua conta. |
|
|
Schedule
|
schedule | string |
Data de envio da mensagem. Isso só é usado pelo serviço de mensagem/agendamento e pode ser deixado vazio para outros serviços. |
|
|
Tag
|
tag | string |
Uma etiqueta de identificação para a mensagem, que pode utilizar para filtrar e comunicar as mensagens que enviou posteriormente. Ideal para campanhas. Um máximo de 280 caracteres. |
|
|
TTL
|
ttl | number |
O número opcional de minutos antes do relatório de entrega é excluído. Opcional. Omitir para impedir a exclusão do relatório de entrega. |
|
|
E-mail de resposta
|
responseemail | array of string |
Uma lista opcional de endereços de e-mail para os quais encaminhar respostas a esta 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 EXPIRADO. Opcional. O padrão é 2880 minutos. |
Devoluções
- response
- array of ScheduledMessageResponse
Obter créditos
Obter ID de cliente
Obter mensagens com falha
Recupere mensagens com falha que correspondam aos seus critérios de pesquisa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
consulta
|
query | True |
Devoluções
- response
- array of MessageResponse
Pesquisar mensagens
Recupere até 1000 mensagens que correspondam aos seus critérios de pesquisa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
consulta
|
query | True |
Devoluções
- response
- array of MessageResponse
Receber mensagem
Recupere uma mensagem registrada pelo ID da mensagem.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da mensagem
|
messageid | True | string |
O ID da mensagem que você gostaria de retornar |
Devoluções
- response
- MessageResponse
Receber mensagens agendadas
Devolve uma lista de mensagens agendadas a partir da sua conta, incluindo quaisquer mensagens agendadas nos últimos 3 meses e quaisquer mensagens agendadas para enviar no futuro.
Devoluções
Detalhes de uma mensagem agendada para ser enviada em uma data e hora especificadas
- response
- ScheduledMessagesResponse
Receber mensagens não lidas
Obtenha mensagens recebidas não lidas que correspondam aos seus critérios de pesquisa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
consulta
|
query | True |
Devoluções
- response
- array of MessageResponse
Recuperar mensagens em lote
Recupere todas as mensagens em um lote com o ID de lote fornecido.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do lote
|
batchid | True | string |
O ID do lote que você gostaria de devolver |
Devoluções
- response
- array of MessageResponse
Definições
TestResponse
CréditosResposta
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