ClickSend

Visão geral

ClickSend é uma plataforma de comunicação em nuvem que permite às empresas enviar e receber SMS, MMS, e-mail, fax e cartas físicas com uma única API. Com a integração ClickSend no SquadOS, seus agentes podem disparar mensagens transacionais ou de marketing, gerenciar listas de contatos, consultar histórico de envios e monitorar o desempenho de campanhas de forma programática.

• Site oficial: https://www.clicksend.com/
• Documentação na Composio: docs.composio.dev/toolkits/clicksend

Autenticação

Esta ferramenta utiliza autenticação básica (usuário/senha) (BASIC) para conectar.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
username	Sim	Nome de usuário da sua conta ClickSend (geralmente o e-mail de cadastro).
password	Sim	Senha da sua conta ClickSend ou chave de API gerada no painel.

Como obter a credencial

1. Acesse dashboard.clicksend.com e faça login.
2. Clique no menu de usuário no canto superior direito e acesse Account Settings (Configurações da conta).
3. Na aba API Credentials, você encontra seu nome de usuário e pode gerar ou visualizar sua chave de API (use a chave no lugar da senha para maior segurança).
4. Copie o nome de usuário e a chave de API — esses são os valores a informar nos campos username e password ao conectar no SquadOS.

Dica

Use sua chave de API no lugar da senha. Isso permite revogar o acesso sem alterar a senha da conta e fornece uma camada adicional de segurança.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por ClickSend.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa as credenciais obtidas acima.
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Ações disponíveis

Nota

Esta integração expõe 166 ações no total. Abaixo estão as principais; a lista completa está na documentação da Composio.

Enviar mensagens SMS

CLICKSEND_CREATE_SMS_SEND

Envia uma ou mais mensagens SMS via ClickSend. Suporta até 1.000 mensagens por chamada de API. Cada mensagem deve ter os campos to (número em formato internacional, ex.: +5511999999999) e body no mínimo. Use o campo schedule (timestamp Unix) para agendar envios futuros.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
messages	array	Sim	Lista de objetos de mensagem SMS a enviar. Cada objeto requer to e body. O campo to deve estar em formato internacional completo com + e código de país. O campo schedule aceita timestamp Unix para agendamento; omita para envio imediato.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Enviar mensagens MMS

CLICKSEND_CREATE_MMS_SEND

Envia mensagens MMS com anexos de mídia para destinatários. Use quando precisar enviar mensagens multimídia com imagens ou arquivos de mídia para um ou mais números de telefone. Suporta até 1.000 mensagens por chamada. Tamanho máximo do arquivo de mídia: 250 kB.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
messages	array	Sim	Array de objetos de mensagem MMS a enviar. Mínimo de 1 mensagem, máximo de 1.000 por chamada.
media_file	string	Sim	URL publicamente acessível do arquivo de mídia/imagem a ser enviado com o MMS. Deve ser uma URL válida. Tamanho máximo: 250 kB (alguns dispositivos mais antigos são limitados a 30 kB).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar e enviar campanha SMS

CLICKSEND_CREATE_SMS_CAMPAIGNS_SEND

Cria e envia uma campanha de SMS para uma lista de contatos. Suporta até 20.000 destinatários por chamada. Mensagens de marketing devem incluir mecanismo de opt-out.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
body	string	Sim	Conteúdo da mensagem a enviar. Deve incluir mecanismo de opt-out para mensagens de marketing (ex.: “Responda PARE para cancelar” ou use o placeholder StopMsg.me/xxxxx).
from	string	Não	Identificação do remetente. Pode ser número compartilhado, número dedicado (formato E.164 como +61353787448), tag alfanumérica (nome da empresa) ou número próprio.
name	string	Sim	Nome da campanha SMS para identificação e rastreamento.
list_id	integer	Sim	ID da lista de contatos para envio da campanha. Use a ação Listar todas as listas de contatos para ver as listas disponíveis.
schedule	integer	Não	Timestamp UNIX para agendar a campanha. Padrão: 0 (envio imediato).
url_to_shorten	string	Não	URL a ser encurtada. Use http://smsg.io/xxxxx como placeholder no corpo da mensagem onde o link encurtado deve aparecer.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Calcular preço de SMS

CLICKSEND_SMS_PRICE_POST

Calcula o preço para enviar mensagens SMS sem efetivamente enviá-las. Use quando precisar estimar o custo de mensagens SMS antes do envio.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
messages	array	Sim	Array de objetos de mensagem SMS para cálculo de preço. Mínimo de 1 mensagem.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Calcular preço de campanha SMS

CLICKSEND_CALCULATE_SMS_CAMPAIGNS_PRICE

Calcula o preço de uma campanha SMS antes de enviá-la. O custo depende do número de destinatários, tamanho da mensagem e países de destino.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
body	string	Sim	Conteúdo da mensagem da campanha. Use placeholders como (First Name) para personalização.
from	string	Não	Identificação do remetente (número de telefone ou ID alfanumérico).
name	string	Sim	Nome da campanha para identificação.
list_id	integer	Sim	ID da lista de contatos contendo os destinatários da campanha.
schedule	integer	Não	Timestamp Unix para agendamento da campanha. Padrão: 0 para envio imediato.
url_to_shorten	string	Não	URL para encurtar na campanha. Ao usar este parâmetro, inclua o placeholder http://smsg.io/xxxxx no corpo da mensagem.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Cancelar campanha SMS

CLICKSEND_SMS_CAMPAIGNS_CANCEL_BY_SMS_CAMPAIGN_ID_PUT

Cancela uma campanha SMS agendada no ClickSend. Somente campanhas agendadas podem ser canceladas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sms_campaign_id	integer	Sim	Identificador único da campanha SMS a cancelar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar campanha SMS

CLICKSEND_UPDATE_SMS_CAMPAIGNS

Atualiza uma campanha SMS existente. Modifica nome, conteúdo, lista de contatos, ID do remetente ou horário de agendamento. Somente campanhas agendadas (com horário futuro) podem ser atualizadas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
body	string	Sim	Conteúdo da mensagem da campanha.
from	string	Não	ID do remetente. Nome ou número que os destinatários verão.
name	string	Sim	Título a atribuir à campanha.
list_id	integer	Sim	ID da lista de contatos que a campanha deve usar.
schedule	integer	Não	Timestamp Unix de quando enviar a campanha. Se omitido ou definido como 0, a campanha envia imediatamente e não pode ser atualizada novamente. Máximo 4 meses no futuro.
url_to_shorten	string	Não	URL para compactar e incluir na mensagem. Insira texto placeholder no corpo onde a URL encurtada deve aparecer.
sms_campaign_id	integer	Sim	Identificador único da campanha SMS a atualizar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter lista de campanhas SMS

CLICKSEND_GET_SMS_CAMPAIGNS3

Recupera todas as campanhas SMS com paginação e detalhamento de estatísticas. Use para visualizar o desempenho e os dados de campanhas para gerenciamento ou geração de relatórios.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Não	Consulta de busca no formato campo:valor. Filtre por campos como name, status, list_id etc.
page	integer	Não	Número de página para resultados paginados. Mínimo: 1.
limit	integer	Não	Número de itens a retornar por página. Entre 15 e 100.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter histórico de SMS

CLICKSEND_GET_SMS_HISTORY

Recupera o histórico de mensagens SMS enviadas com filtragem e paginação. Use para visualizar mensagens enviadas anteriormente ou verificar o status de entrega.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Não	String de consulta personalizada para filtrar resultados. Formato: campo:valor separados por vírgulas. Ex.: status:Sent ou to:+5511999999999.
page	integer	Não	Número de página para paginação.
limit	integer	Não	Número de registros por página.
date_to	integer	Não	Filtrar mensagens enviadas até esta data. Formato timestamp Unix (segundos desde a época).
date_from	integer	Não	Filtrar mensagens enviadas a partir desta data. Formato timestamp Unix.
order_by	string	Não	Ordenar resultados por campo. Formato: campo:asc ou campo:desc (ex.: date:desc).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter comprovantes de entrega SMS

CLICKSEND_GET_SMS_RECEIPTS

Recupera os comprovantes de entrega SMS da sua conta ClickSend. Use quando precisar pesquisar e visualizar o status de entrega de SMS, incluindo timestamps, códigos de status e detalhes de erro. Requer uma regra de relatório de entrega com ação definida como POLL no painel.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
page	integer	Não	Número da página para paginação. Mínimo: 1. Padrão: 1.
limit	integer	Não	Número de registros por página. Mínimo: 1. Padrão: 15.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter comprovante de entrega SMS por ID de mensagem

CLICKSEND_SMS_RECEIPTS_BY_MESSAGE_ID_GET

Recupera um único comprovante de entrega SMS usando o identificador da mensagem. Use quando precisar verificar o status, os detalhes de entrega ou o custo de uma transmissão SMS específica.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
message_id	string	Sim	Identificador único da mensagem SMS (formato UUID).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter estatísticas de SMS

CLICKSEND_GET_STATISTICS_SMS

Recupera estatísticas de mensagens SMS da sua conta ClickSend. Use quando precisar visualizar métricas de uso, dados de preços e detalhamentos por data das atividades de mensagens SMS, incluindo enviados, recebidos e com falha.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar lista de contatos

CLICKSEND_CREATE_LISTS

Cria uma nova lista de contatos na sua conta ClickSend. Use para organizar contatos em listas separadas para campanhas de mensagens direcionadas. A API permite até 2.000 listas de contatos por conta.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
list_name	string	Sim	Nome da lista de contatos a criar. Máximo de 50 caracteres (nomes mais longos serão truncados). Nomes duplicados são permitidos; cada lista terá um list_id único.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar contato em lista

CLICKSEND_CREATE_LISTS_CONTACTS

Cria um novo contato em uma lista de contatos específica na sua conta ClickSend. Pelo menos um dos campos phone_number, email ou fax_number deve ser informado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
list_id	integer	Sim	Identificador único da lista de contatos onde o contato será criado.
phone_number	string	Não	Número de telefone do contato no formato E.164 (ex.: +61411111111). Pelo menos um de phone_number, email ou fax_number deve ser fornecido.
email	string	Não	Endereço de e-mail do contato. Pelo menos um de phone_number, email ou fax_number deve ser fornecido.
first_name	string	Não	Primeiro nome do contato.
last_name	string	Não	Sobrenome do contato.
organization_name	string	Não	Nome da organização ou empresa do contato.
address_line_1	string	Não	Primeira linha do endereço do contato.
address_city	string	Não	Cidade do endereço do contato.
address_state	string	Não	Estado ou província do endereço do contato.
address_postal_code	string	Não	CEP ou código postal do endereço do contato.
address_country	string	Não	Código de país ISO 3166-1 alpha-2 em maiúsculas (ex.: BR, US).
custom_1	string	Não	Campo personalizado 1 para informações adicionais do contato.
custom_2	string	Não	Campo personalizado 2 para informações adicionais do contato.
custom_3	string	Não	Campo personalizado 3 para informações adicionais do contato.
custom_4	string	Não	Campo personalizado 4 para informações adicionais do contato.
fax_number	string	Não	Número de fax do contato. Pelo menos um de phone_number, email ou fax_number deve ser fornecido.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar todas as listas de contatos

CLICKSEND_GET_LISTS

Recupera todas as listas de contatos da conta ClickSend com suporte a paginação. Use quando precisar visualizar as listas disponíveis para gerenciar contatos e campanhas de mensagens.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
page	integer	Não	Número de página para resultados paginados. Mínimo: 1.
limit	integer	Não	Número de registros por página. Mínimo: 1.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar contatos de uma lista

CLICKSEND_GET_LISTS_CONTACTS

Recupera todos os contatos de uma lista de contatos específica na sua conta ClickSend com suporte a paginação e filtragem.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
list_id	integer	Sim	Identificador único da lista de contatos da qual recuperar os contatos.
page	integer	Não	Número de página para resultados paginados. Mínimo: 1.
limit	integer	Não	Número de registros por página. Entre 1 e 100.
updated_after	integer	Não	Timestamp Unix para filtrar contatos. Retorna somente contatos atualizados após este timestamp.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar contato em lista

CLICKSEND_UPDATE_LISTS_CONTACTS

Atualiza um contato específico em uma lista de contatos. Use para modificar detalhes como número de telefone, e-mail, nome, endereço ou campos personalizados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
list_id	integer	Sim	Identificador único da lista de contatos que contém o contato.
contact_id	integer	Sim	Identificador único do contato a atualizar.
phone_number	string	Não	Número de telefone do contato no formato E.164 (ex.: +14155552999).
email	string	Não	Endereço de e-mail do contato.
first_name	string	Não	Primeiro nome do contato.
last_name	string	Não	Sobrenome do contato.
organization_name	string	Não	Nome da organização ou empresa do contato.
address_line_1	string	Não	Primeira linha do endereço do contato.
address_city	string	Não	Cidade do endereço do contato.
address_state	string	Não	Estado ou província do endereço.
address_postal_code	string	Não	CEP ou código postal.
address_country	string	Não	Código de país ISO 3166 (2 letras) para o endereço do contato.
custom_1	string	Não	Campo personalizado 1 para informações adicionais do contato.
custom_2	string	Não	Campo personalizado 2 para informações adicionais do contato.
custom_3	string	Não	Campo personalizado 3 para informações adicionais do contato.
custom_4	string	Não	Campo personalizado 4 para informações adicionais do contato.
fax_number	string	Não	Número de fax do contato.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir lista de contatos

CLICKSEND_DELETE_LISTS

Exclui uma lista de contatos específica da sua conta ClickSend permanentemente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
list_id	integer	Sim	Identificador único da lista de contatos a excluir.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir contato de lista

CLICKSEND_DELETE_LISTS_CONTACTS

Exclui um contato específico de uma lista de contatos na sua conta ClickSend permanentemente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
list_id	integer	Sim	Identificador único da lista de contatos da qual o contato será excluído.
contact_id	integer	Sim	Identificador único do contato a excluir da lista.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Importar contatos para lista

CLICKSEND_GET_LISTS_IMPORT

Importa contatos para uma lista de contatos a partir de uma URL de arquivo publicamente acessível. Use para importar contatos em massa de um arquivo CSV ou Excel para uma lista específica. O processo de importação pode ser assíncrono.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
list_id	integer	Sim	Identificador único da lista de contatos para importar os contatos.
file_url	string	Sim	URL do arquivo a processar. Deve ser uma URL publicamente acessível apontando para um arquivo CSV ou Excel com os contatos a importar.
field_order	array	Sim	Ordem dos campos no arquivo. Especifica como as colunas do arquivo mapeiam para campos de contato. Valores válidos: phone, phone_number, first_name, last_name, email, fax_number, address_line_1, address_line_2, address_city, address_state, address_postal_code, address_country, organization_name, custom_1, custom_2, custom_3, custom_4.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Exportar lista de contatos

CLICKSEND_GET_LISTS_EXPORT

Exporta os contatos de uma lista específica para um arquivo CSV. Use quando precisar baixar todos os contatos de uma lista para backup, análise ou migração.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
list_id	integer	Sim	ID da lista de contatos a exportar.
filename	string	Sim	Nome do arquivo para baixar a lista de contatos (ex.: contatos_export.csv). Deve incluir a extensão .csv.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter informações da conta

CLICKSEND_GET_ACCOUNT

Recupera as informações da conta do usuário autenticado. Use quando precisar visualizar detalhes da conta, como saldo, informações do usuário, configurações e detalhes de cobrança.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Enviar carta física

CLICKSEND_CREATE_POST_LETTERS_SEND

Envia cartas físicas por meio do serviço postal do ClickSend. Use quando precisar enviar um documento PDF como carta física para um ou mais destinatários. Para arquivos docx/doc, converta-os primeiro pelo endpoint /uploads?convert=post.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
file_url	string	Sim	URL do arquivo PDF a enviar. Formatos suportados: pdf, docx, doc, jpg, gif, png, bmp.
recipients	array	Sim	Array de objetos destinatário. Cada destinatário representa uma pessoa que receberá uma cópia da carta.
colour	integer	Não	Se a carta é impressa em cores. 0 = preto e branco, 1 = colorida. Padrão: 0.
duplex	integer	Não	Se a carta é impressa frente e verso. 0 = face simples, 1 = frente e verso. Padrão: 0.
priority_post	integer	Não	Se a carta é entregue via correio prioritário. 0 = correio normal, 1 = correio prioritário. Padrão: 0.
source	string	Não	Identificador de origem para fins de rastreamento. Pode ser qualquer string.
template_used	integer	Não	Se está usando um modelo do ClickSend. 0 = não usa modelo, 1 = usa modelo. Padrão: 0.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar automação de SMS recebido

CLICKSEND_CREATE_AUTOMATIONS_SMS_INBOUND

Cria uma nova regra de automação de SMS recebido no ClickSend. Use quando precisar configurar ações automáticas para disparar quando mensagens SMS de entrada forem recebidas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
action	string	Sim	Ação a executar quando a regra corresponder. Valores válidos: AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL, CREATE_CONTACT_PLUS_NAME, SMPP, NONE.
enabled	integer	Sim	Controla o status de ativação da regra. 0 = desativada, 1 = ativada.
rule_name	string	Sim	Nome da regra de automação para identificação.
action_address	string	Sim	Destino alvo para a ação especificada. Para EMAIL_FIXED, forneça endereço de e-mail; para URL, forneça URL de webhook; para listas de contatos, forneça ID da lista.
dedicated_number	string	Sim	Número de telefone dedicado ao qual aplicar esta regra. Use * para aplicar a regra a todos os números.
message_search_type	integer	Sim	Lógica de correspondência de mensagem. 0 = qualquer mensagem, 1 = começa com, 2 = contém, 3 = não contém.
message_search_term	string	Não	Padrão de texto para corresponder contra mensagens de entrada. Pode ser nulo para message_search_type=0 (qualquer mensagem).
webhook_type	string	Não	Formato do tipo de webhook. Valores válidos: post, get ou json. Padrão: post.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter mensagens SMS recebidos

CLICKSEND_GET_SMS_INBOUND

Recupera mensagens SMS recebidas pela sua conta ClickSend. Use quando precisar visualizar mensagens enviadas para seus números ClickSend por clientes ou destinatários, ou monitorar respostas de entrada. Para receber mensagens via polling de API, configure primeiro uma regra de entrada com ação definida como POLL no painel ClickSend.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Não	Consulta de busca para filtrar mensagens SMS recebidas. Formato: campo:valor (ex.: from:+5511999999999). Campos pesquisáveis: from, to, message_id, body.
page	integer	Não	Número de página para paginação. Padrão: 1.
limit	integer	Não	Número de registros por página. Padrão: 15.
order_by	string	Não	Ordem de classificação. Formato: campo:direção (ex.: date:desc para os mais recentes primeiro).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Cancelar todos os SMS agendados

CLICKSEND_SMS_CANCEL_ALL_PUT

Cancela todas as mensagens SMS agendadas na conta ClickSend. Afeta apenas mensagens agendadas para entrega futura que ainda não foram enviadas. Sem custom_string, cancela todos os SMS agendados; com custom_string, cancela apenas os que correspondem a esse identificador.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
custom_string	string	Não	Filtro opcional para cancelar somente mensagens agendadas com este valor de custom_string específico. Se não fornecido, cancela todos os SMS agendados.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.