ClickSend
ClickSend para SMS de negócios que é entregue; alertas, notificações, convites, mensagens de marketing e muito mais. O ClickSend é um software de comunicação empresarial que permite que empresas de todas as formas e tamanhos enviem e recebam facilmente SMS, Email, Voz e até postagem em todo o mundo por meio de aplicativo Web ou API. O ClickSend tem SMS em seu núcleo e gera bilhões de mensagens em todo o mundo por meio de rotas diretas, mas expandiu-se para oferecer um conjunto completo de produtos que fornecem opções e contexto para suas comunicações comerciais.
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 | Suporte a SMS do ClickSend |
| URL | https://www.clicksend.com/au/help |
| Support@clicksend.com |
| Metadados do conector | |
|---|---|
| Publicador | Sinch Suécia AB |
| Site | https://www.clicksend.com |
| Política de privacidade | https://www.clicksend.com/us/legal/privacy-policy |
| Categorias | Comunicação; Marketing |
Conector do ClickSend para Microsoft Power Automate
Crie fluxos de trabalho automatizados entre aplicativos para sincronizar arquivos, obter notificações, coletar dados e muito mais com o Microsoft Power Automate. Conecte o ClickSend ao Power Automate para adicionar mensagens automatizadas aos seus fluxos de trabalho , em quase qualquer sistema.
Sobrecarregar suas mensagens com o ClickSend
O conector ClickSend permite que você integre recursos avançados de mensagens aos seus fluxos de trabalho automatizados. Com apenas alguns cliques, você pode conectar o ClickSend a mais de 700 conectores do Microsoft Power Automate para criar fluxos de comunicação contínuos.
Principais características
- Enviar SMS — envie mensagens SMS automaticamente disparadas por eventos em outros aplicativos (por exemplo, envios de formulários, atualizações de calendário, emails).
- Enviar MMS – Compartilhar conteúdo multimídia como imagens ou arquivos por meio de fluxos de trabalho automatizados.
- Enviar Voz – Use arquivos de texto em fala ou áudio para fornecer chamadas de voz.
- Enviar Fax – Enviar faxes digitais diretamente de seus fluxos.
- Enviar Post – enviar cartas ou cartões postais automaticamente por meio de serviços postais.
Casos de uso de exemplo
- Receba um SMS quando uma reunião for adicionada ou alterada em seu calendário.
- Obtenha uma notificação de texto quando receber um email de um cliente VIP.
- Envie um MMS do ClickSend quando um novo arquivo é carregado no Dropbox.
- Automatize o marketing ou o envolvimento do cliente com fluxos de trabalho de mensagens modelos.
- Gerencie listas de contatos ou responda a mensagens SMS de entrada com gatilhos personalizados.
Use nossos modelos pré-criados para simplificar a instalação ou criar suas próprias automações personalizadas com facilidade.
Como conectar sua conta do ClickSend
- Navegue até o painel do Power Automate .
- Vá para Conexões > de Dados > Nova conexão.
- Pesquise por SMS clickSend.
- Insira suas credenciais de API clickSend:
-
username: nome de usuário da sua conta do ClickSend -
api_key: sua chave de API do Painel clickSend
-
- Clique em Criar , sua conta agora está conectada!
Requirements
- Uma conta clickSend (inscreva-se no clicksend.com).
- Credenciais de API (nome de usuário e chave de API).
Saiba Mais
Visite o Portal do Desenvolvedor do ClickSend para explorar recursos completos de API e casos de uso.
Aprimore seus fluxos de trabalho com mensagens automatizadas , com o ClickSend e o Microsoft Power Automate.
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 |
| Chave de API | secureString | A chave de API para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à 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 contatos |
Criar nova lista de contatos |
| Criar novo contato |
Criar novo contato |
| Enviar Carta |
Enviar Carta |
| Enviar Cartão Postal |
Enviar um ou mais cartões postais |
| 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 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 contatos em uma lista |
Obter todos os contatos em uma lista |
| Obter listas de contatos |
Obter todas as listas de contatos, a menos que especificado nas opções antecipadas |
| Pesquisar listas de contatos |
Obter lista de contatos pesquisados |
Converter formato de arquivo de mídia
Converter formato de arquivo de mídia
Parâmetros
| Nome | Chave | Obrigató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 |
|
File
|
content | True | byte |
Conteúdo do Arquivo (base64) |
Retornos
| Nome | 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 |
|
Carregar ID
|
data.upload_id | integer |
Carregar ID |
|
Nome do Arquivo
|
data.file_name | string |
Nome do Arquivo |
|
Data adicionada
|
data.date_added | integer |
Data adicionada |
|
Exclusão de data
|
data.date_delete | integer |
Exclusão de data |
|
ID do Usuário
|
data.user_id | integer |
ID do Usuário |
|
URL
|
data._url | string |
URL |
Criar nova lista de contatos
Criar nova lista de contatos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da Lista
|
list_name | True | string |
Nome da lista de contatos |
Retornos
| Nome | 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 |
|
Listar ID de Email
|
data.list_email_id | string |
Listar ID de Email |
|
Contagem de contatos
|
data._contacts_count | integer |
Contagem de contatos |
Criar novo contato
Criar novo contato
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | integer |
Você pode usar a ação Pesquisar Lista de Contatos ou obter a ação Lista de Contatos para obter a ID da Lista |
|
Primeiro Nome
|
first_name | True | string |
Nome do contato. |
|
Apelido
|
last_name | True | string |
Sobrenome do contato. |
|
Número de Telefone
|
phone_number | True | string |
O telefone de contato no formato local ou internacional, por exemplo, +61411111111. |
|
Email
|
string |
Endereço de email do contato. |
||
|
Número do fax
|
fax_number | string |
Número de fax do contato. |
|
|
Nome da Organização
|
organization_name | string |
Nome da organização do contato. |
|
|
País
|
address_country | string |
O país do contato. |
|
|
Estado
|
address_state | string |
Estado |
|
|
City
|
address_city | string |
Cidade do Endereço |
|
|
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 |
|
|
Linha de endereço 2
|
address_line_2 | string |
Linha de endereço 2 |
Retornos
| Nome | 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 |
|
Primeiro Nome
|
data.first_name | string |
Primeiro Nome |
|
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 adicionada
|
data.date_added | integer |
Data adicionada |
|
Número do fax
|
data.fax_number | string |
Número do 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 |
|
Linha de endereço 2
|
data.address_line_2 | string |
Linha de endereço 2 |
|
Cidade do Endereço
|
data.address_city | string |
Cidade do Endereço |
|
Estado do endereço
|
data.address_state | string |
Estado do endereço |
|
Endereço Postal Code
|
data.address_postal_code | string |
Endereço Postal Code |
|
País de endereço
|
data.address_country | string |
País de endereço |
|
Nome da Lista
|
data._list_name | string |
Nome da Lista |
Enviar Carta
Enviar Carta
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL do Arquivo PDF
|
file_url | True | string |
O tamanho máximo do arquivo é de 10 MB. Todas as páginas devem estar em retrato. Converse com o Suporte do ClickSend para especificações completas. |
|
Modelo usado
|
template_used | integer |
Se está usando o modelo de letra. O valor do sinalizador deve ser 1 para sim ou 0 para não. |
|
|
Cor
|
colour | True | integer |
Escolha usar a cor ou impressão B&W. (Preto &Branco = 0, Cor = 1) |
|
Duplex
|
duplex | True | integer |
Escolha usar a impressão Duplex = 1 (lado duplo) ou Simplex = 0(lado único). |
|
Postagem de Prioridade
|
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 |
|
País
|
address_country | True | string |
País |
|
Selecionar Endereço de Retorno
|
return_address_id | True | integer |
ID do endereço de retorno a ser usada |
|
Linha de endereço 1
|
address_line_1 | True | string |
Primeira linha de endereço |
|
Linha de endereço 2
|
address_line_2 | string |
Segunda linha de endereço |
Retornos
| Nome | 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 enfileirada
|
data.queued_count | integer |
Contagem enfileirada |
|
destinatários
|
data.recipients | array of object |
item |
|
ID do Usuário
|
data.recipients.user_id | integer |
ID do Usuário |
|
ID da subcontagem
|
data.recipients.subaccount_id | integer |
ID da subcontagem |
|
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 |
|
Linha de endereço 2
|
data.recipients.address_line_2 | string |
Linha de endereço 2 |
|
Cidade do Endereço
|
data.recipients.address_city | string |
Cidade do Endereço |
|
Estado do endereço
|
data.recipients.address_state | string |
Estado do endereço |
|
Endereço Postal Code
|
data.recipients.address_postal_code | string |
Endereço Postal Code |
|
País de endereço
|
data.recipients.address_country | string |
País de endereço |
|
ID do endereço de retorno
|
data.recipients.return_address_id | integer |
ID do endereço de retorno |
|
Cadeia de caracteres personalizada
|
data.recipients.custom_string | string |
Cadeia de caracteres personalizada |
|
Source
|
data.recipients.source | string |
Source |
|
Cor
|
data.recipients.colour | integer |
Cor |
|
Duplex
|
data.recipients.duplex | integer |
Duplex |
|
Postar Páginas
|
data.recipients.post_pages | integer |
Postar Páginas |
|
Pós-Preço
|
data.recipients.post_price | string |
Pós-Preço |
|
Postagem de Prioridade
|
data.recipients.priority_post | integer |
Postagem de Prioridade |
|
Data adicionada
|
data.recipients.date_added | integer |
Data adicionada |
|
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 do Usuário
|
data.recipients._return_address.user_id | integer |
ID do Usuário |
|
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 |
|
Linha de endereço 2
|
data.recipients._return_address.address_line_2 | string |
Linha de endereço 2 |
|
Cidade do Endereço
|
data.recipients._return_address.address_city | string |
Cidade do Endereço |
|
Estado do endereço
|
data.recipients._return_address.address_state | string |
Estado do endereço |
|
Endereço Postal Code
|
data.recipients._return_address.address_postal_code | string |
Endereço Postal Code |
|
País de endereço
|
data.recipients._return_address.address_country | string |
País de endereço |
|
Nome de usuário da API
|
data.recipients._api_username | string |
Nome de usuário da API |
|
Nome da moeda curto
|
data._currency.currency_name_short | string |
Nome da moeda curto |
|
Prefixo D de moeda
|
data._currency.currency_prefix_d | string |
Prefixo D de moeda |
|
Prefixo de moeda C
|
data._currency.currency_prefix_c | string |
Prefixo de moeda C |
|
Nome da moeda longo
|
data._currency.currency_name_long | string |
Nome da moeda longo |
Enviar Cartão Postal
Enviar um ou mais cartões postais
Parâmetros
| Nome | Chave | Obrigató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 |
|
País
|
address_country | True | string |
País |
|
ID do endereço de retorno
|
return_address_id | True | integer |
ID do endereço de retorno a ser usada |
|
Linha de endereço 1
|
address_line_1 | True | string |
Primeira linha de endereço |
|
Linha de endereço 2
|
address_line_2 | string |
Segunda linha de endereço |
|
|
file_urls
|
file_urls | True | array of string |
URL do Arquivo PDF |
Retornos
| Nome | 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 enfileirada
|
data.queued_count | integer |
Contagem enfileirada |
|
destinatários
|
data.recipients | array of object |
Recipient |
|
ID do Usuário
|
data.recipients.user_id | integer |
ID do Usuário |
|
ID da subcontagem
|
data.recipients.subaccount_id | integer |
ID da subcontagem |
|
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 |
|
Linha de endereço 2
|
data.recipients.address_line_2 | string |
Linha de endereço 2 |
|
Cidade do Endereço
|
data.recipients.address_city | string |
Cidade do Endereço |
|
Estado do endereço
|
data.recipients.address_state | string |
Estado do endereço |
|
Endereço Postal Code
|
data.recipients.address_postal_code | string |
Endereço Postal Code |
|
País de endereço
|
data.recipients.address_country | string |
País de endereço |
|
ID do endereço de retorno
|
data.recipients.return_address_id | integer |
ID do endereço de retorno |
|
Cronograma
|
data.recipients.schedule | integer |
Cronograma |
|
Pós-Preço
|
data.recipients.post_price | string |
Pós-Preço |
|
Situação
|
data.recipients.status | string |
Situação |
|
Data adicionada
|
data.recipients.date_added | integer |
Data adicionada |
|
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 do Usuário
|
data.recipients._return_address.user_id | integer |
ID do Usuário |
|
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 |
|
Linha de endereço 2
|
data.recipients._return_address.address_line_2 | string |
Linha de endereço 2 |
|
Cidade do Endereço
|
data.recipients._return_address.address_city | string |
Cidade do Endereço |
|
Estado do endereço
|
data.recipients._return_address.address_state | string |
Estado do endereço |
|
Endereço Postal Code
|
data.recipients._return_address.address_postal_code | string |
Endereço Postal Code |
|
País de endereço
|
data.recipients._return_address.address_country | string |
País de endereço |
|
Nome de usuário da API
|
data.recipients._api_username | string |
Nome de usuário da API |
|
Nome da moeda curto
|
data._currency.currency_name_short | string |
Nome da moeda curto |
|
Prefixo D de moeda
|
data._currency.currency_prefix_d | string |
Prefixo D de moeda |
|
Prefixo de moeda C
|
data._currency.currency_prefix_c | string |
Prefixo de moeda C |
|
Nome da moeda longo
|
data._currency.currency_name_long | string |
Nome da moeda longo |
Enviar Fax
Enviar Fax
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Para
|
to | True | string |
Número de telefone no formato E.164. Eg. +61261111111. |
|
Cadeia de caracteres personalizada
|
custom_string | string |
Essa é a sua referência. Ele será exibido em todos os relatórios e será passado de volta com quaisquer respostas. |
|
|
URL do Arquivo PDF
|
file_url | True | string |
O tamanho máximo do arquivo é de 4 MB. Todas as páginas devem estar em retrato. Chat com o Suporte do ClickSend para especificações completas |
Retornos
| Nome | 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 enfileirada
|
data.queued_count | integer |
Contagem enfileirada |
|
messages
|
data.messages | array of object |
messages |
|
ID do Usuário
|
data.messages.user_id | integer |
ID do Usuário |
|
ID da subcontagem
|
data.messages.subaccount_id | integer |
ID da subcontagem |
|
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 |
|
Portador
|
data.messages.carrier | string |
Portador |
|
País
|
data.messages.country | string |
País |
|
Cadeia de caracteres personalizada
|
data.messages.custom_string | string |
Cadeia de caracteres personalizada |
|
Páginas de Mensagens
|
data.messages.message_pages | integer |
Páginas de Mensagens |
|
Preço da Mensagem
|
data.messages.message_price | string |
Preço da Mensagem |
|
Código de status
|
data.messages.status_code | string |
Código de status |
|
Texto de status
|
data.messages.status_text | string |
Texto de status |
|
Data adicionada
|
data.messages.date_added | integer |
Data adicionada |
|
Por email
|
data.messages.from_email | string |
Por email |
|
URL do Arquivo
|
data.messages._file_url | string |
URL do Arquivo |
|
Situação
|
data.messages.status | string |
Situação |
|
Nome da moeda curto
|
data._currency.currency_name_short | string |
Nome da moeda curto |
|
Prefixo D de moeda
|
data._currency.currency_prefix_d | string |
Prefixo D de moeda |
|
Prefixo de moeda C
|
data._currency.currency_prefix_c | string |
Prefixo de moeda C |
|
Nome da moeda longo
|
data._currency.currency_name_long | string |
Nome da moeda longo |
Enviar Mensagem de Voz
Cada 300 caracteres = 1 mensagem de voz. Pode enviar até 1.200 caracteres padrão
Parâmetros
| Nome | Chave | Obrigató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 for enviado para um país diferente, por exemplo, +61411111111. |
|
Corpo
|
body | True | string |
Corpo da mensagem a ser lido. |
|
Linguagem
|
lang | True | string |
Escolha qual idioma você deseja usar. |
|
Serviço de Voz
|
voice | True | string |
Escolha a mensagem a ser lida em uma voz Masculina de Mulher. |
|
Cadeia de caracteres personalizada
|
custom_string | string |
Essa é a sua referência. Ele será exibido em todos os relatórios e será passado de volta com quaisquer respostas. |
|
|
Exigir entrada
|
require_input | integer |
Receba uma tecla do destinatário. O valor do sinalizador deve ser 1 para sim ou 0 para não. |
|
|
Detecção de computador
|
machine_detection | integer |
Detecte o computador de resposta ou a caixa postal e deixe uma mensagem. O valor do sinalizador deve ser 1 para sim ou 0 para não. |
Retornos
| Nome | 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 enfileirada
|
data.queued_count | integer |
Contagem enfileirada |
|
messages
|
data.messages | array of object |
messages |
|
ID do Usuário
|
data.messages.user_id | integer |
ID do Usuário |
|
ID da subcontagem
|
data.messages.subaccount_id | integer |
ID da subcontagem |
|
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 |
|
Serviço de Voz
|
data.messages.voice | string |
Serviço de Voz |
|
Linguagem
|
data.messages.lang | string |
Linguagem |
|
Corpo
|
data.messages.body | string |
Bddy |
|
Portador
|
data.messages.carrier | string |
Portador |
|
País
|
data.messages.country | string |
País |
|
Cadeia de caracteres personalizada
|
data.messages.custom_string | string |
Cadeia de caracteres personalizada |
|
Cronograma
|
data.messages.schedule | integer |
Cronograma |
|
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 adicionada
|
data.messages.date_added | integer |
Data adicionada |
|
Exigir entrada
|
data.messages.require_input | integer |
Exigir entrada |
|
Detecção de computador
|
data.messages.machine_detection | integer |
Detecção de computador |
|
Situação
|
data.messages.status | string |
Situação |
|
Nome da moeda curto
|
data._currency.currency_name_short | string |
Nome da moeda curto |
|
Prefixo D de moeda
|
data._currency.currency_prefix_d | string |
Prefixo D de moeda |
|
Prefixo de moeda C
|
data._currency.currency_prefix_c | string |
Prefixo de moeda C |
|
Nome da moeda longo
|
data._currency.currency_name_long | string |
Nome da moeda longo |
Enviar MMS
Enviar MMS
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
para
|
to | True | string |
Número de telefone celular. Pode estar em formato local ou internacional. Deve estar no formato internacional (E.164) se for enviado para outro país. por exemplo, +61411111111. |
|
assunto
|
subject | True | string |
Linha de assunto. Máximo de 20 caracteres. |
|
mensagem
|
body | True | string |
Corpo da mensagem. Até 1500 caracteres ou 500 caracteres Unicode |
|
Cadeia de caracteres personalizada
|
custom_string | string |
Essa é a sua referência. Ele será exibido em todos os relatórios e será passado de volta com quaisquer respostas. |
|
|
URL de mídia
|
media_file | True | string |
Dá suporte ao tamanho máximo do arquivo de 250 kB, o Gif só poderá ter suporte se ele estiver abaixo do tamanho do arquivo de 100 kB |
Retornos
| Nome | 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 enfileirada
|
data.queued_count | integer |
Contagem enfileirada |
|
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 |
|
Corpo
|
data.messages.body | string |
Corpo |
|
País
|
data.messages.country | string |
País |
|
Cadeia de caracteres personalizada
|
data.messages.custom_string | string |
Cadeia de caracteres 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 SMS
Cada 160 caracteres = 1 SMS. Pode enviar até 1.224 caracteres padrão.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Para
|
to | True | string |
Número de telefone celular. Pode estar em formato local ou internacional. Deve estar no formato internacional (E.164) se for enviado para outro país. por exemplo, +61411111111. |
|
Corpo
|
body | True | string |
160 caracteres é 1 SMS. Pode enviar até 1.224 caracteres padrão. |
|
Cadeia de caracteres personalizada
|
custom_string | string |
Essa é a sua referência. Ele será exibido em todos os relatórios e será passado de volta com quaisquer respostas. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código Http
|
http_code | integer |
Código Http |
|
Código de Resposta
|
response_code | string |
Código de Resposta |
|
Msg de resposta
|
response_msg | string |
Msg de resposta |
|
Preço Total
|
data.total_price | float |
Preço Total |
|
Contagem total
|
data.total_count | integer |
Contagem total |
|
Contagem enfileirada
|
data.queued_count | integer |
Contagem enfileirada |
|
messages
|
data.messages | array of object |
Message |
|
Direção
|
data.messages.direction | string |
Direção |
|
Date
|
data.messages.date | integer |
Date |
|
Para
|
data.messages.to | string |
Para |
|
Corpo
|
data.messages.body | string |
Corpo |
|
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 |
|
Por email
|
data.messages.from_email | string |
Por email |
|
ID da lista
|
data.messages.list_id | string |
ID da lista |
|
Cadeia de caracteres personalizada
|
data.messages.custom_string | string |
Cadeia de caracteres personalizada |
|
ID de contato
|
data.messages.contact_id | string |
ID de contato |
|
Identificação de usuário
|
data.messages.user_id | integer |
Identificação de usuário |
|
ID da subcontagem
|
data.messages.subaccount_id | integer |
ID da subcontagem |
|
País
|
data.messages.country | string |
País |
|
Portador
|
data.messages.carrier | string |
Portador |
|
Situação
|
data.messages.status | string |
Situação |
|
Nome da moeda curto
|
data._currency.currency_name_short | string |
Nome da moeda curto |
|
Prefixo D de moeda
|
data._currency.currency_prefix_d | string |
Prefixo D de moeda |
|
Prefixo de moeda C
|
data._currency.currency_prefix_c | string |
Prefixo de moeda C |
|
Nome da moeda longo
|
data._currency.currency_name_long | string |
Nome da moeda longo |
Excluir Lista
Excluir uma lista de contatos específica
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | integer |
Você pode usar a ação Pesquisar Lista de Contatos ou obter a ação Lista de Contatos para obter a ID da Lista |
Retornos
| Nome | 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | integer |
Você pode usar a ação Pesquisar Lista de Contatos ou obter a ação Lista de Contatos para obter a ID da Lista |
|
ID de contato
|
contact_id | True | integer |
ID de contato |
Retornos
| Nome | 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 contatos em uma lista
Obter todos os contatos em uma lista
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | integer |
Você pode usar a ação Pesquisar Lista de Contatos ou obter a ação Lista de Contatos para obter a ID da Lista |
Retornos
| Nome | 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 Próxima Página
|
data.next_page_url | string |
Url da Próxima Página |
|
Url da Página de Pré-desenvolvimento
|
data.prev_page_url | string |
Url da Página de Pré-desenvolvimento |
|
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 |
|
Primeiro Nome
|
data.data.first_name | string |
Primeiro Nome |
|
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 adicionada |
|
Data atualizada
|
data.data.date_updated | integer |
Data atualizada |
|
Número do fax
|
data.data.fax_number | string |
Número do 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 |
|
Linha de endereço 2
|
data.data.address_line_2 | string |
Linha de endereço 2 |
|
Cidade do Endereço
|
data.data.address_city | string |
Cidade do Endereço |
|
Estado do endereço
|
data.data.address_state | string |
Estado do endereço |
|
Endereço Postal Code
|
data.data.address_postal_code | string |
Endereço Postal Code |
|
País de endereço
|
data.data.address_country | string |
País de endereço |
|
Nome da Lista
|
data.data._list_name | string |
Nome da Lista |
Obter listas de contatos
Obter todas as listas de contatos, a menos que especificado nas opções antecipadas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número da página
|
page | integer |
Número da página |
|
|
Número de registros por página
|
limit | integer |
Número de registros por página |
Retornos
| Nome | 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 Próxima Página
|
data.next_page_url | string |
Url da Próxima Página |
|
Url da Página de Pré-desenvolvimento
|
data.prev_page_url | string |
Url da Página de Pré-desenvolvimento |
|
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 |
|
Listar ID de Email
|
data.data.list_email_id | string |
Listar ID de Email |
|
Contagem de contatos
|
data.data._contacts_count | integer |
Contagem de contatos |
|
Importar Entrada
|
data.data._import_in_progress | integer |
Importar Entrada |
|
Entrada do OptOut
|
data.data._optout_in_progress | integer |
Entrada do OptOut |
Pesquisar listas de contatos
Obter lista de contatos pesquisados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da Lista
|
q | True | string |
Procurar |
Retornos
| Nome | 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 Próxima Página
|
data.next_page_url | string |
Url da Próxima Página |
|
Url da Página de Pré-desenvolvimento
|
data.prev_page_url | string |
Url da Página de Pré-desenvolvimento |
|
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 contatos
|
data.data.contacts_count | integer |
Contagem de contatos |
Gatilhos
| Automação de entrada de SMS |
Criar uma nova automação de SMS de entrada |
Automação de entrada de SMS
Criar uma nova automação de SMS de entrada
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Corpo
|
body | string |
body |
|
Para
|
to | string |
Número de telefone do destinatário |
|
De
|
from | string |
ID do remetente |
|
Cadeia de caracteres personalizada
|
custom_string | string |
custom_string |
|
ID da Mensagem Original
|
original_message_id | string |
original_message_id |
|
Corpo Original
|
original_body | string |
Corpo Original |
|
Identificação de usuário
|
user_id | integer |
A ID do usuário que enviou a mensagem. |
|
ID da subcontagem
|
subaccount_id | integer |
A ID de subcontagem do usuário que enviou a mensagem. |
|
Timestamp
|
timestamp | integer |
Carimbo de data/hora no formato UNIX |
|
ID da mensagem
|
message_id | string |
A ID da mensagem de entrada |