ClickSend
ClickSend para SMS de negócios que é entregue; alertas, notificações, convites, mensagens de marketing e muito mais. ClickSend é um software de comunicação empresarial que permite que empresas de todas as formas e tamanhos enviem e recebam facilmente SMS, e-mail, voz e até mesmo postem em todo o mundo via aplicativo da web ou API. O ClickSend tem o SMS no seu núcleo e alimenta milhares de milhões de mensagens em todo o mundo através de rotas diretas, mas expandiu-se para oferecer um conjunto completo de produtos, proporcionando escolha e contexto para as comunicações da sua empresa.
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 | ClickSend SMS Suporte |
| URL | https://www.clicksend.com/au/help |
| Support@clicksend.com |
| Metadados do conector | |
|---|---|
| Editora | Sinch Suécia AB |
| Sítio Web | https://www.clicksend.com |
| Política de privacidade | https://www.clicksend.com/us/legal/privacy-policy |
| Categorias | Comunicação; Comercialização |
ClickSend Connector para Microsoft Power Automate
Crie fluxos de trabalho automatizados entre aplicativos para sincronizar arquivos, receber notificações, coletar dados e muito mais com o Microsoft Power Automate. Conecte o ClickSend com o Power Automate para adicionar mensagens automatizadas aos seus fluxos de trabalho — em praticamente qualquer sistema.
Melhore suas mensagens com o ClickSend
O conector ClickSend permite que você integre recursos poderosos de mensagens em seus fluxos de trabalho automatizados. Com apenas alguns cliques, você pode conectar o ClickSend a mais de 700+ conectores Microsoft Power Automate para criar fluxos de comunicação contínuos.
Principais características
- Enviar SMS — Envie automaticamente mensagens SMS acionadas por eventos em outros aplicativos (por exemplo, envios de formulários, atualizações de calendário, e-mails).
- Enviar MMS — Compartilhe conteúdo multimídia, como imagens ou arquivos, por meio de fluxos de trabalho automatizados.
- Enviar voz — Use arquivos de texto para fala ou áudio para fazer chamadas de voz.
- Enviar fax — Envie faxes digitais diretamente de seus fluxos.
- Enviar correio — Envie automaticamente cartas ou postais através dos serviços postais.
Exemplos de casos de uso
- Receba um SMS quando uma reunião for adicionada ou alterada no seu calendário.
- Receba uma notificação de texto quando receber um e-mail de um cliente VIP.
- Envie um MMS do ClickSend quando um novo arquivo for carregado no Dropbox.
- Automatize o marketing ou o envolvimento do cliente com fluxos de trabalho de mensagens modelados.
- Gerencie listas de contatos ou responda a mensagens SMS recebidas com gatilhos personalizados.
Use nossos modelos pré-criados para simplificar a configuração ou crie suas próprias automações personalizadas com facilidade.
Como conectar sua conta ClickSend
- Navegue até o painel Power Automatic .
- Vá para Conexões de Dados >> Nova conexão.
- Procure por ClickSend SMS.
- Insira suas credenciais da API ClickSend:
-
username: O nome de utilizador da sua conta ClickSend -
api_key: Sua chave de API do Painel ClickSend
-
- Clique em Criar — a sua conta está agora ligada!
Requerimentos
- Uma conta ClickSend (inscreva-se em clicksend.com).
- Credenciais da API (nome de usuário e chave da API).
Saiba mais
Visite o ClickSend Developer Portal para explorar todos os recursos de API e casos de uso.
Melhore os seus fluxos de trabalho com mensagens automatizadas — com ClickSend e Microsoft Power Automate.
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 |
| Chave de API | securestring | A chave de API 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
| Converter Formato de Arquivo de Mídia |
Converter Formato de Arquivo de Mídia |
| Criar Nova Lista de Contactos |
Criar Nova Lista de Contactos |
| Criar Novo Contacto |
Criar Novo Contacto |
| Enviar Carta |
Enviar Carta |
| Enviar fax |
Enviar fax |
| Enviar mensagem de voz |
Cada 300 caracteres = 1 mensagem de voz. Pode enviar até 1.200 caracteres padrão |
| Enviar MMS |
Enviar MMS |
| Enviar Postal |
Enviar um ou mais postais |
| Enviar SMS |
Cada 160 caracteres = 1 SMS. Pode enviar até 1.224 caracteres padrão. |
| Excluir lista |
Excluir uma lista de contatos específica |
| Excluir um contato |
Excluir um contato |
| Obter contactos numa lista |
Obter todos os contactos numa lista |
| Obter listas de contactos |
Obter todas as listas de contatos, a menos que especificado nas opções antecipadas |
| Pesquisar Listas de Contactos |
Obter lista de contatos pesquisados |
Converter Formato de Arquivo de Mídia
Converter Formato de Arquivo de Mídia
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Selecione a ação para a qual o arquivo é necessário
|
convert | True | string |
Selecione a ação para a qual o arquivo é necessário |
|
Ficheiro
|
content | True | byte |
Conteúdo do arquivo (base64) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código Http
|
http_code | integer |
Código Http |
|
Código de Resposta
|
response_code | string |
Código de Resposta |
|
Mensagem de resposta
|
response_msg | string |
Mensagem de resposta |
|
ID de carregamento
|
data.upload_id | integer |
ID de carregamento |
|
Nome do arquivo
|
data.file_name | string |
Nome do arquivo |
|
Data de Adição
|
data.date_added | integer |
Data de Adição |
|
Data de exclusão
|
data.date_delete | integer |
Data de exclusão |
|
ID de utilizador
|
data.user_id | integer |
ID de utilizador |
|
Endereço URL
|
data._url | string |
Endereço URL |
Criar Nova Lista de Contactos
Criar Nova Lista de Contactos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da lista
|
list_name | True | string |
O nome da sua lista de contactos |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código Http
|
http_code | integer |
Código Http |
|
Código de Resposta
|
response_code | string |
Código de Resposta |
|
Mensagem de resposta
|
response_msg | string |
Mensagem de resposta |
|
ID da lista
|
data.list_id | integer |
ID da lista |
|
Nome da lista
|
data.list_name | string |
Nome da lista |
|
ID de e-mail da lista
|
data.list_email_id | string |
ID de e-mail da lista |
|
Contagem de Contactos
|
data._contacts_count | integer |
Contagem de Contactos |
Criar Novo Contacto
Criar Novo Contacto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | integer |
Você pode usar a ação Pesquisar Lista de Contatos OU Obter Lista de Contatos para obter a ID da Lista |
|
Nome Próprio
|
first_name | True | string |
Nome próprio do contacto. |
|
Apelido
|
last_name | True | string |
Apelido do contacto. |
|
Número de Telefone
|
phone_number | True | string |
O telefone de contacto em formato local ou internacional, por exemplo, +61411111111. |
|
Email
|
string |
Endereço de e-mail do contato. |
||
|
Número de Fax
|
fax_number | string |
Número de fax do contato. |
|
|
Nome da Organização
|
organization_name | string |
Nome da organização do contato. |
|
|
Country
|
address_country | string |
O país do contacto. |
|
|
Estado
|
address_state | string |
Estado |
|
|
City
|
address_city | string |
Endereço Cidade |
|
|
Personalizado 1
|
custom_1 | string |
Personalizado 1 |
|
|
Personalizado 3
|
custom_3 | string |
Personalizado 3 |
|
|
Código Postal
|
address_postal_code | string | ||
|
Personalizado 2
|
custom_2 | string |
Personalizado 2 |
|
|
Personalizado 4
|
custom_4 | string |
Personalizado 4 |
|
|
Linha de Endereço 1
|
address_line_1 | string |
Linha de Endereço 1 |
|
|
Endereço Linha 2
|
address_line_2 | string |
Endereço Linha 2 |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código Http
|
http_code | integer |
Código Http |
|
Código de Resposta
|
response_code | string |
Código de Resposta |
|
Mensagem de resposta
|
response_msg | string |
Mensagem de resposta |
|
ID de contato
|
data.contact_id | integer |
ID de contato |
|
ID da lista
|
data.list_id | integer |
ID da lista |
|
Número de Telefone
|
data.phone_number | string |
Número de Telefone |
|
Nome Próprio
|
data.first_name | string |
Nome Próprio |
|
Apelido
|
data.last_name | string |
Apelido |
|
Personalizado 1
|
data.custom_1 | string |
Personalizado 1 |
|
Personalizado 2
|
data.custom_2 | string |
Personalizado 2 |
|
Personalizado 3
|
data.custom_3 | string |
Personalizado 3 |
|
Personalizado 4
|
data.custom_4 | string |
Personalizado 4 |
|
Data de Adição
|
data.date_added | integer |
Data de Adição |
|
Número de Fax
|
data.fax_number | string |
Número de Fax |
|
Nome da Organização
|
data.organization_name | string |
Nome da Organização |
|
Email
|
data.email | string |
|
|
Linha de Endereço 1
|
data.address_line_1 | string |
Linha de Endereço 1 |
|
Endereço Linha 2
|
data.address_line_2 | string |
Endereço Linha 2 |
|
Endereço Cidade
|
data.address_city | string |
Endereço Cidade |
|
Estado do endereço
|
data.address_state | string |
Estado do endereço |
|
Endereço Código Postal
|
data.address_postal_code | string |
Endereço Código Postal |
|
Endereço País
|
data.address_country | string |
Endereço País |
|
Nome da lista
|
data._list_name | string |
Nome da lista |
Enviar Carta
Enviar Carta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do ficheiro PDF
|
file_url | True | string |
O tamanho máximo do ficheiro é de 10 MB. Todas as páginas devem estar em retrato. Converse com o Suporte ClickSend para obter especificações completas. |
|
Modelo usado
|
template_used | integer |
Seja usando modelo de letra. O valor do sinalizador deve ser 1 para sim ou 0 para não. |
|
|
Cor
|
colour | True | integer |
Opte por utilizar impressão a cores ou P&B. (Preto & Branco = 0, Cor = 1) |
|
Duplex
|
duplex | True | integer |
Opte por utilizar a impressão Duplex = 1 (frente e verso) ou Simplex = 0 (frente e verso). |
|
Postagem prioritária
|
priority_post | integer |
Se a letra é prioridade, o valor do sinalizador deve ser 1 para sim ou 0 para não. |
|
|
Nome
|
address_name | True | string |
Nome do endereço |
|
City
|
address_city | True | string |
City |
|
Estado
|
address_state | True | string |
Estado |
|
Código Postal
|
address_postal_code | True | string |
Código Postal |
|
Country
|
address_country | True | string |
Country |
|
Selecione Endereço de Retorno
|
return_address_id | True | integer |
ID de endereço de retorno a ser usado |
|
Linha de Endereço 1
|
address_line_1 | True | string |
Primeira linha de endereço |
|
Endereço Linha 2
|
address_line_2 | string |
Segunda linha de endereço |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código Http
|
http_code | integer |
Código Http |
|
Código de Resposta
|
response_code | string |
Código de Resposta |
|
Mensagem de resposta
|
response_msg | string |
Mensagem de resposta |
|
Preço Total
|
data.total_price | float |
Preço Total |
|
Contagem Total
|
data.total_count | integer |
Contagem Total |
|
Contagem em fila
|
data.queued_count | integer |
Contagem em fila |
|
recipients
|
data.recipients | array of object |
item |
|
ID de utilizador
|
data.recipients.user_id | integer |
ID de utilizador |
|
ID da subconta
|
data.recipients.subaccount_id | integer |
ID da subconta |
|
ID da mensagem
|
data.recipients.message_id | string |
ID da mensagem |
|
Nome do endereço
|
data.recipients.address_name | string |
Nome do endereço |
|
Linha de Endereço 1
|
data.recipients.address_line_1 | string |
Linha de Endereço 1 |
|
Endereço Linha 2
|
data.recipients.address_line_2 | string |
Endereço Linha 2 |
|
Endereço Cidade
|
data.recipients.address_city | string |
Endereço Cidade |
|
Estado do endereço
|
data.recipients.address_state | string |
Estado do endereço |
|
Endereço Código Postal
|
data.recipients.address_postal_code | string |
Endereço Código Postal |
|
Endereço País
|
data.recipients.address_country | string |
Endereço País |
|
ID do endereço de retorno
|
data.recipients.return_address_id | integer |
ID do endereço de retorno |
|
String personalizada
|
data.recipients.custom_string | string |
String personalizada |
|
Fonte
|
data.recipients.source | string |
Fonte |
|
Cor
|
data.recipients.colour | integer |
Cor |
|
Duplex
|
data.recipients.duplex | integer |
Duplex |
|
Publicar Páginas
|
data.recipients.post_pages | integer |
Publicar Páginas |
|
Pós Preço
|
data.recipients.post_price | string |
Pós Preço |
|
Postagem prioritária
|
data.recipients.priority_post | integer |
Postagem prioritária |
|
Data de Adição
|
data.recipients.date_added | integer |
Data de Adição |
|
Situação
|
data.recipients.status | string |
Situação |
|
URL do arquivo
|
data.recipients._file_url | string |
URL do arquivo |
|
ID do endereço de retorno
|
data.recipients._return_address.return_address_id | integer |
ID do endereço de retorno |
|
ID de utilizador
|
data.recipients._return_address.user_id | integer |
ID de utilizador |
|
Nome do endereço
|
data.recipients._return_address.address_name | string |
Nome do endereço |
|
Linha de Endereço 1
|
data.recipients._return_address.address_line_1 | string |
Linha de Endereço 1 |
|
Endereço Linha 2
|
data.recipients._return_address.address_line_2 | string |
Endereço Linha 2 |
|
Endereço Cidade
|
data.recipients._return_address.address_city | string |
Endereço Cidade |
|
Estado do endereço
|
data.recipients._return_address.address_state | string |
Estado do endereço |
|
Endereço Código Postal
|
data.recipients._return_address.address_postal_code | string |
Endereço Código Postal |
|
Endereço País
|
data.recipients._return_address.address_country | string |
Endereço País |
|
Nome de usuário da API
|
data.recipients._api_username | string |
Nome de usuário da API |
|
Nome da moeda Short
|
data._currency.currency_name_short | string |
Nome da moeda Short |
|
Prefixo da moeda D
|
data._currency.currency_prefix_d | string |
Prefixo da moeda D |
|
Prefixo de moeda C
|
data._currency.currency_prefix_c | string |
Prefixo de moeda C |
|
Nome da moeda Long
|
data._currency.currency_name_long | string |
Nome da moeda Long |
Enviar fax
Enviar fax
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Para
|
to | True | string |
Número de telefone no formato E.164. Eg. +61261111111. |
|
String personalizada
|
custom_string | string |
Esta é a sua referência. Ele será exibido em todos os relatórios e será repassado com quaisquer respostas. |
|
|
URL do ficheiro PDF
|
file_url | True | string |
O tamanho máximo do ficheiro é de 4 MB. Todas as páginas devem estar em retrato. Bate-papo com o suporte ClickSend para obter especificações completas |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código Http
|
http_code | integer |
Código Http |
|
Código de Resposta
|
response_code | string |
Código de Resposta |
|
Mensagem de resposta
|
response_msg | string |
Mensagem de resposta |
|
Preço Total
|
data.total_price | float |
Preço Total |
|
Contagem Total
|
data.total_count | integer |
Contagem Total |
|
Contagem em fila
|
data.queued_count | integer |
Contagem em fila |
|
messages
|
data.messages | array of object |
messages |
|
ID de utilizador
|
data.messages.user_id | integer |
ID de utilizador |
|
ID da subconta
|
data.messages.subaccount_id | integer |
ID da subconta |
|
ID da lista
|
data.messages.list_id | string |
ID da lista |
|
ID da mensagem
|
data.messages.message_id | string |
ID da mensagem |
|
Para
|
data.messages.to | string |
Para |
|
De
|
data.messages.from | string |
De |
|
Transportadora
|
data.messages.carrier | string |
Transportadora |
|
Country
|
data.messages.country | string |
Country |
|
String personalizada
|
data.messages.custom_string | string |
String personalizada |
|
Páginas de Mensagem
|
data.messages.message_pages | integer |
Páginas de Mensagem |
|
Preço da mensagem
|
data.messages.message_price | string |
Preço da mensagem |
|
Código de estado
|
data.messages.status_code | string |
Código de estado |
|
Texto de status
|
data.messages.status_text | string |
Texto de status |
|
Data de Adição
|
data.messages.date_added | integer |
Data de Adição |
|
Do e-mail
|
data.messages.from_email | string |
Do e-mail |
|
URL do arquivo
|
data.messages._file_url | string |
URL do arquivo |
|
Situação
|
data.messages.status | string |
Situação |
|
Nome da moeda Short
|
data._currency.currency_name_short | string |
Nome da moeda Short |
|
Prefixo da moeda D
|
data._currency.currency_prefix_d | string |
Prefixo da moeda D |
|
Prefixo de moeda C
|
data._currency.currency_prefix_c | string |
Prefixo de moeda C |
|
Nome da moeda Long
|
data._currency.currency_name_long | string |
Nome da moeda Long |
Enviar mensagem de voz
Cada 300 caracteres = 1 mensagem de voz. Pode enviar até 1.200 caracteres padrão
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Para
|
to | True | string |
Número de telefone móvel ou fixo em formato local ou internacional. Deve estar em formato internacional (E.164) se enviar para um país diferente.por exemplo. +61411111111. |
|
Body
|
body | True | string |
Corpo da mensagem a ser lido. |
|
Linguagem
|
lang | True | string |
Escolha o idioma que deseja usar. |
|
Voice
|
voice | True | string |
Escolha a mensagem a ser lida em voz masculina ou feminina. |
|
String personalizada
|
custom_string | string |
Esta é a sua referência. Ele será exibido em todos os relatórios e será repassado com quaisquer respostas. |
|
|
Exigir entrada
|
require_input | integer |
Receba um pressionamento de tecla do destinatário. O valor do sinalizador deve ser 1 para sim ou 0 para não. |
|
|
Deteção de Máquinas
|
machine_detection | integer |
Detete a secretária eletrônica ou o correio de voz e deixe uma mensagem. O valor do sinalizador deve ser 1 para sim ou 0 para não. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código Http
|
http_code | integer |
Código Http |
|
Código de Resposta
|
response_code | string |
Código de Resposta |
|
Mensagem de resposta
|
response_msg | string |
Mensagem de resposta |
|
Preço Total
|
data.total_price | float |
Preço Total |
|
Contagem Total
|
data.total_count | integer |
Contagem Total |
|
Contagem em fila
|
data.queued_count | integer |
Contagem em fila |
|
messages
|
data.messages | array of object |
messages |
|
ID de utilizador
|
data.messages.user_id | integer |
ID de utilizador |
|
ID da subconta
|
data.messages.subaccount_id | integer |
ID da subconta |
|
ID da mensagem
|
data.messages.message_id | string |
ID da mensagem |
|
Para
|
data.messages.to | string |
Para |
|
Para digitar
|
data.messages.to_type | string |
Para digitar |
|
De
|
data.messages.from | string |
De |
|
Voice
|
data.messages.voice | string |
Voice |
|
Linguagem
|
data.messages.lang | string |
Linguagem |
|
Body
|
data.messages.body | string |
Bddy |
|
Transportadora
|
data.messages.carrier | string |
Transportadora |
|
Country
|
data.messages.country | string |
Country |
|
String personalizada
|
data.messages.custom_string | string |
String personalizada |
|
Schedule
|
data.messages.schedule | integer |
Schedule |
|
Partes da mensagem
|
data.messages.message_parts | integer |
Partes da mensagem |
|
Preço da mensagem
|
data.messages.message_price | string |
Preço da mensagem |
|
Data de Adição
|
data.messages.date_added | integer |
Data de Adição |
|
Exigir entrada
|
data.messages.require_input | integer |
Exigir entrada |
|
Deteção de Máquinas
|
data.messages.machine_detection | integer |
Deteção de Máquinas |
|
Situação
|
data.messages.status | string |
Situação |
|
Nome da moeda Short
|
data._currency.currency_name_short | string |
Nome da moeda Short |
|
Prefixo da moeda D
|
data._currency.currency_prefix_d | string |
Prefixo da moeda D |
|
Prefixo de moeda C
|
data._currency.currency_prefix_c | string |
Prefixo de moeda C |
|
Nome da moeda Long
|
data._currency.currency_name_long | string |
Nome da moeda Long |
Enviar MMS
Enviar MMS
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Para
|
to | True | string |
Número de telemóvel. Pode ser em formato local ou internacional. Deve estar em formato internacional (E.164) se enviar para outro país. por exemplo, +61411111111. |
|
Assunto
|
subject | True | string |
Linha de assunto. Máximo 20 caracteres. |
|
mensagem
|
body | True | string |
Corpo da mensagem. Até 1500 caracteres ou 500 caracteres Unicode |
|
String personalizada
|
custom_string | string |
Esta é a sua referência. Ele será exibido em todos os relatórios e será repassado com quaisquer respostas. |
|
|
URL de mídia
|
media_file | True | string |
Suporta tamanho máximo de arquivo de 250kB, Gif só pode ser suportado se ele abaixo de 100 kB tamanho de arquivo |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código Http
|
http_code | integer |
Código Http |
|
Código de Resposta
|
response_code | string |
Código de Resposta |
|
Mensagem de resposta
|
response_msg | string |
Mensagem de resposta |
|
Preço Total
|
data.total_price | float |
Preço Total |
|
Contagem Total
|
data.total_count | integer |
Contagem Total |
|
Contagem em fila
|
data.queued_count | integer |
Contagem em fila |
|
messages
|
data.messages | array of object |
Msg |
|
ID da lista
|
data.messages.list_id | integer |
ID da lista |
|
ID de contato
|
data.messages.contact_id | integer |
ID de contato |
|
ID da mensagem
|
data.messages.message_id | string |
ID da mensagem |
|
Para
|
data.messages.to | string |
Para |
|
Assunto
|
data.messages.subject | string |
Assunto |
|
De
|
data.messages.from | string |
De |
|
Body
|
data.messages.body | string |
Body |
|
Country
|
data.messages.country | string |
Country |
|
String personalizada
|
data.messages.custom_string | string |
String personalizada |
|
Partes da mensagem
|
data.messages.message_parts | integer |
Partes da mensagem |
|
Preço da mensagem
|
data.messages.message_price | string |
Preço da mensagem |
|
URL do arquivo de mídia
|
data.messages._media_file_url | string |
URL do arquivo de mídia |
|
Situação
|
data.messages.status | string |
Situação |
Enviar Postal
Enviar um ou mais postais
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
address_name | True | string |
Nome do endereço |
|
City
|
address_city | True | string |
City |
|
Estado
|
address_state | True | string |
Estado |
|
Código Postal
|
address_postal_code | True | string |
Código Postal |
|
Country
|
address_country | True | string |
Country |
|
ID do endereço de retorno
|
return_address_id | True | integer |
ID de endereço de retorno a ser usado |
|
Linha de Endereço 1
|
address_line_1 | True | string |
Primeira linha de endereço |
|
Endereço Linha 2
|
address_line_2 | string |
Segunda linha de endereço |
|
|
file_urls
|
file_urls | True | array of string |
URL do ficheiro PDF |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código Http
|
http_code | integer |
Código Http |
|
Código de Resposta
|
response_code | string |
Código de Resposta |
|
Mensagem de resposta
|
response_msg | string |
Mensagem de resposta |
|
Preço Total
|
data.total_price | double |
Preço Total |
|
Contagem Total
|
data.total_count | integer |
Contagem Total |
|
Contagem em fila
|
data.queued_count | integer |
Contagem em fila |
|
recipients
|
data.recipients | array of object |
Recipient |
|
ID de utilizador
|
data.recipients.user_id | integer |
ID de utilizador |
|
ID da subconta
|
data.recipients.subaccount_id | integer |
ID da subconta |
|
ID da mensagem
|
data.recipients.message_id | string |
ID da mensagem |
|
Nome do endereço
|
data.recipients.address_name | string |
Nome do endereço |
|
Linha de Endereço 1
|
data.recipients.address_line_1 | string |
Linha de Endereço 1 |
|
Endereço Linha 2
|
data.recipients.address_line_2 | string |
Endereço Linha 2 |
|
Endereço Cidade
|
data.recipients.address_city | string |
Endereço Cidade |
|
Estado do endereço
|
data.recipients.address_state | string |
Estado do endereço |
|
Endereço Código Postal
|
data.recipients.address_postal_code | string |
Endereço Código Postal |
|
Endereço País
|
data.recipients.address_country | string |
Endereço País |
|
ID do endereço de retorno
|
data.recipients.return_address_id | integer |
ID do endereço de retorno |
|
Schedule
|
data.recipients.schedule | integer |
Schedule |
|
Pós Preço
|
data.recipients.post_price | string |
Pós Preço |
|
Situação
|
data.recipients.status | string |
Situação |
|
Data de Adição
|
data.recipients.date_added | integer |
Data de Adição |
|
URL do arquivo
|
data.recipients._file_url | string |
URL do arquivo |
|
ID do endereço de retorno
|
data.recipients._return_address.return_address_id | integer |
ID do endereço de retorno |
|
ID de utilizador
|
data.recipients._return_address.user_id | integer |
ID de utilizador |
|
Nome do endereço
|
data.recipients._return_address.address_name | string |
Nome do endereço |
|
Linha de Endereço 1
|
data.recipients._return_address.address_line_1 | string |
Linha de Endereço 1 |
|
Endereço Linha 2
|
data.recipients._return_address.address_line_2 | string |
Endereço Linha 2 |
|
Endereço Cidade
|
data.recipients._return_address.address_city | string |
Endereço Cidade |
|
Estado do endereço
|
data.recipients._return_address.address_state | string |
Estado do endereço |
|
Endereço Código Postal
|
data.recipients._return_address.address_postal_code | string |
Endereço Código Postal |
|
Endereço País
|
data.recipients._return_address.address_country | string |
Endereço País |
|
Nome de usuário da api
|
data.recipients._api_username | string |
Nome de usuário da api |
|
Nome da moeda Short
|
data._currency.currency_name_short | string |
Nome da moeda Short |
|
Prefixo da moeda D
|
data._currency.currency_prefix_d | string |
Prefixo da moeda D |
|
Prefixo de moeda C
|
data._currency.currency_prefix_c | string |
Prefixo de moeda C |
|
Nome da moeda Long
|
data._currency.currency_name_long | string |
Nome da moeda Long |
Enviar SMS
Cada 160 caracteres = 1 SMS. Pode enviar até 1.224 caracteres padrão.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Para
|
to | True | string |
Número de telemóvel. Pode ser em formato local ou internacional. Deve estar em formato internacional (E.164) se enviar para outro país. por exemplo, +61411111111. |
|
Body
|
body | True | string |
160 caracteres é 1 SMS. Pode enviar até 1.224 caracteres padrão. |
|
String personalizada
|
custom_string | string |
Esta é a sua referência. Ele será exibido em todos os relatórios e será repassado com quaisquer respostas. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código Http
|
http_code | integer |
Código Http |
|
Código de Resposta
|
response_code | string |
Código de Resposta |
|
Mensagem de resposta
|
response_msg | string |
Mensagem de resposta |
|
Preço Total
|
data.total_price | float |
Preço Total |
|
Contagem Total
|
data.total_count | integer |
Contagem Total |
|
Contagem em fila
|
data.queued_count | integer |
Contagem em fila |
|
messages
|
data.messages | array of object |
Message |
|
Direction
|
data.messages.direction | string |
Direction |
|
Date
|
data.messages.date | integer |
Date |
|
Para
|
data.messages.to | string |
Para |
|
Body
|
data.messages.body | string |
Body |
|
De
|
data.messages.from | string |
De |
|
ID da mensagem
|
data.messages.message_id | string |
ID da mensagem |
|
Partes da mensagem
|
data.messages.message_parts | integer |
Partes da mensagem |
|
Preço da mensagem
|
data.messages.message_price | string |
Preço da mensagem |
|
Do e-mail
|
data.messages.from_email | string |
Do e-mail |
|
ID da lista
|
data.messages.list_id | string |
ID da lista |
|
String personalizada
|
data.messages.custom_string | string |
String personalizada |
|
ID de contato
|
data.messages.contact_id | string |
ID de contato |
|
ID do Utilizador
|
data.messages.user_id | integer |
ID do Utilizador |
|
ID da subconta
|
data.messages.subaccount_id | integer |
ID da subconta |
|
Country
|
data.messages.country | string |
Country |
|
Transportadora
|
data.messages.carrier | string |
Transportadora |
|
Situação
|
data.messages.status | string |
Situação |
|
Nome da moeda Short
|
data._currency.currency_name_short | string |
Nome da moeda Short |
|
Prefixo da moeda D
|
data._currency.currency_prefix_d | string |
Prefixo da moeda D |
|
Prefixo de moeda C
|
data._currency.currency_prefix_c | string |
Prefixo de moeda C |
|
Nome da moeda Long
|
data._currency.currency_name_long | string |
Nome da moeda Long |
Excluir lista
Excluir uma lista de contatos específica
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | integer |
Você pode usar a ação Pesquisar Lista de Contatos OU Obter Lista de Contatos para obter a ID da Lista |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código Http
|
http_code | integer |
Código Http |
|
Código de Resposta
|
response_code | string |
Código de Resposta |
|
Mensagem de resposta
|
response_msg | string |
Mensagem de resposta |
Excluir um contato
Excluir um contato
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | integer |
Você pode usar a ação Pesquisar Lista de Contatos OU Obter Lista de Contatos para obter a ID da Lista |
|
ID de contato
|
contact_id | True | integer |
ID de contato |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código Http
|
http_code | integer |
Código Http |
|
Código de Resposta
|
response_code | string |
Código de Resposta |
|
Mensagem de resposta
|
response_msg | string |
Mensagem de resposta |
Obter contactos numa lista
Obter todos os contactos numa lista
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | integer |
Você pode usar a ação Pesquisar Lista de Contatos OU Obter Lista de Contatos para obter a ID da Lista |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código Http
|
http_code | integer |
Código Http |
|
Código de Resposta
|
response_code | string |
Código de Resposta |
|
Mensagem de resposta
|
response_msg | string |
Mensagem de resposta |
|
Total
|
data.total | integer |
Total |
|
Por Página
|
data.per_page | integer |
Por Página |
|
Página Atual
|
data.current_page | integer |
Página Atual |
|
Última Página
|
data.last_page | integer |
Última Página |
|
URL da página seguinte
|
data.next_page_url | string |
URL da página seguinte |
|
URL da página anterior
|
data.prev_page_url | string |
URL da página anterior |
|
De
|
data.from | integer |
De |
|
Para
|
data.to | integer |
Para |
|
dados
|
data.data | array of object |
dados |
|
ID de contato
|
data.data.contact_id | integer |
ID de contato |
|
ID da lista
|
data.data.list_id | integer |
ID da lista |
|
Número de Telefone
|
data.data.phone_number | string |
Número de Telefone |
|
Nome Próprio
|
data.data.first_name | string |
Nome Próprio |
|
Apelido
|
data.data.last_name | string |
Apelido |
|
Personalizado 1
|
data.data.custom_1 | string |
Personalizado 1 |
|
Personalizado 2
|
data.data.custom_2 | string |
Personalizado 2 |
|
Personalizado 3
|
data.data.custom_3 | string |
Personalizado 3 |
|
Personalizado 4
|
data.data.custom_4 | string |
Personalizado 4 |
|
date_added
|
data.data.date_added | integer |
Data de Adição |
|
Data de atualização
|
data.data.date_updated | integer |
Data de atualização |
|
Número de Fax
|
data.data.fax_number | string |
Número de Fax |
|
Nome da Organização
|
data.data.organization_name | string |
Nome da Organização |
|
Email
|
data.data.email | string |
|
|
Linha de Endereço 1
|
data.data.address_line_1 | string |
Linha de Endereço 1 |
|
Endereço Linha 2
|
data.data.address_line_2 | string |
Endereço Linha 2 |
|
Endereço Cidade
|
data.data.address_city | string |
Endereço Cidade |
|
Estado do endereço
|
data.data.address_state | string |
Estado do endereço |
|
Endereço Código Postal
|
data.data.address_postal_code | string |
Endereço Código Postal |
|
Endereço País
|
data.data.address_country | string |
Endereço País |
|
Nome da lista
|
data.data._list_name | string |
Nome da lista |
Obter listas de contactos
Obter todas as listas de contatos, a menos que especificado nas opções antecipadas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Número da página
|
page | integer |
Número da página |
|
|
Número de registos por página
|
limit | integer |
Número de registos por página |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código Http
|
http_code | integer |
Código Http |
|
Código de Resposta
|
response_code | string |
Código de Resposta |
|
Mensagem de resposta
|
response_msg | string |
Mensagem de resposta |
|
Total
|
data.total | integer |
Total |
|
Por Página
|
data.per_page | integer |
Por Página |
|
Página Atual
|
data.current_page | integer |
Página Atual |
|
Última Página
|
data.last_page | integer |
Última Página |
|
URL da página seguinte
|
data.next_page_url | string |
URL da página seguinte |
|
URL da página anterior
|
data.prev_page_url | string |
URL da página anterior |
|
De
|
data.from | integer |
De |
|
Para
|
data.to | integer |
Para |
|
dados
|
data.data | array of object |
dados |
|
ID da lista
|
data.data.list_id | integer |
ID da lista |
|
Nome da lista
|
data.data.list_name | string |
Nome da lista |
|
ID de e-mail da lista
|
data.data.list_email_id | string |
ID de e-mail da lista |
|
Contagem de contatos
|
data.data._contacts_count | integer |
Contagem de Contactos |
|
Importação em Andamento
|
data.data._import_in_progress | integer |
Importação em Andamento |
|
OptOut em andamento
|
data.data._optout_in_progress | integer |
OptOut em andamento |
Pesquisar Listas de Contactos
Obter lista de contatos pesquisados
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da lista
|
q | True | string |
Pesquisar por |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código Http
|
http_code | integer |
Código Http |
|
Código de Resposta
|
response_code | string |
Código de Resposta |
|
Mensagem de resposta
|
response_msg | string |
Mensagem de resposta |
|
Total
|
data.total | integer |
Total |
|
Por Página
|
data.per_page | integer |
Por Página |
|
Página Atual
|
data.current_page | integer |
Página Atual |
|
Última Página
|
data.last_page | integer |
Última Página |
|
URL da página seguinte
|
data.next_page_url | string |
URL da página seguinte |
|
URL da página anterior
|
data.prev_page_url | string |
URL da página anterior |
|
De
|
data.from | integer |
De |
|
Para
|
data.to | integer |
Para |
|
dados
|
data.data | array of object |
dados |
|
Id
|
data.data.id | integer |
Id |
|
Nome
|
data.data.name | string |
Nome |
|
Contato
|
data.data.contact | string |
Contato |
|
Tipo
|
data.data.type | string |
Tipo |
|
Contagem de Contactos
|
data.data.contacts_count | integer |
Contagem de Contactos |
Acionadores
| Automação de entrada de SMS |
Crie uma nova automação de SMS de entrada |
Automação de entrada de SMS
Crie uma nova automação de SMS de entrada
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Body
|
body | string |
body |
|
Para
|
to | string |
Número de telefone do destinatário |
|
De
|
from | string |
ID do remetente |
|
String personalizada
|
custom_string | string |
custom_string |
|
ID da mensagem original
|
original_message_id | string |
original_message_id |
|
Corpo Original
|
original_body | string |
Corpo Original |
|
ID do Utilizador
|
user_id | integer |
O ID de usuário do usuário que enviou a mensagem. |
|
ID da subconta
|
subaccount_id | integer |
O ID da subconta do usuário que enviou a mensagem. |
|
Data e Hora
|
timestamp | integer |
Carimbo de data/hora em formato UNIX |
|
ID da mensagem
|
message_id | string |
O ID da mensagem para a mensagem de entrada |