v2.0.0OAS 3.1.0

SendWork API

A API do SendWork permite que os usuários interajam com a plataforma para gerenciar tarefas, gerar chaves de API e muito mais. Ela foi projetada para ser intuitiva e fácil de usar, garantindo integração perfeita com várias aplicações.

Autenticação

Para acessar a API do SendWork, os usuários devem possuir uma chave de API válida. Para solicitar uma chave de API, entre em contato com nosso suporte através do email suporte@sendwork.com. Nossa equipe fornecerá as informações necessárias para que você possa começar a utilizar a API.

Webhooks de DLR

O sistema permite que você receba atualizações de status de envio (DLRs) em tempo real configurando uma URL para receber os webhooks. Para configurar a URL, acesse o link https://app.sendwork.com.br/ e vá no Menu > Integração. Lá é possível informar a URL desejada para receber os DLRs.

Enviar Mensagem (v1)

Este método é responsável por enviar a mensagem para a campanha transacional mencionada, processando os dados do usuário conforme necessário.

Body

requiredapplication/json

Dados do usuário a serem processados

API_KEYstring

Chave de API do usuário

Example

IdAPIUsuariostring · uuid

Identificador único do usuário

Example

GuidCampanhastring · uuid

Identificador único da campanha

Example

Telefonestring

Número de telefone para o qual a mensagem será enviada

Example

Responses

{
  "message": "Ok",
  "IdAPIUsuario": "c582ffa8-5087-41d3-aae2-7919ae5852fc",
  "IdRetorno": "67a5ccc89c4e4886881d4913b33131d8ec"
}

POST/api/v1/send

curl https://api.sendwork.com.br/api/v1/send \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "API_KEY": "67a5ccc89c4e4886881d4913b331d8ec",
  "IdAPIUsuario": "c582ffa8-5087-41d3-aae2-7919ae5852fc",
  "GuidCampanha": "b234fa7e-5290-44d3-bce2-2a3769f8baf1",
  "Telefone": "5511987654321"
}'

200400

{
  "message": "Ok",
  "IdAPIUsuario": "c582ffa8-5087-41d3-aae2-7919ae5852fc",
  "IdRetorno": "67a5ccc89c4e4886881d4913b33131d8ec"
}

Dados processados com sucesso

Enviar Mensagem (v2)

Este método é responsável por enviar mensagens, incluindo novos parâmetros no corpo da requisição, como msgTexto e tipoEnvio. Ele processa e envia as mensagens com base nos dados fornecidos.

Body

requiredapplication/json

Dados do usuário a serem processados

API_KEYstring

Chave de API do usuário

Example

IdAPIUsuariostring · uuid

Identificador único do usuário

Example

GuidCampanhastring · uuid

Identificador único da campanha

Example

Telefonestring

Número de telefone para o qual a mensagem será enviada

Example

MsgTextostring

Texto da mensagem que será enviada

Example

TipoEnviostring · enum

Define o tipo de envio, podendo ser SMS ou VOZ

Example

SMS

VOZ

Responses

{
  "message": "Ok",
  "IdAPIUsuario": "2e98905a-d861-4669-9668-21741508adag",
  "IdRetorno": "67a5ccc89c4e4886881d4913b323131d8ec"
}

POST/api/v2/send

curl https://api.sendwork.com.br/api/v2/send \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "API_KEY": "3g7997551ef24d78821925b2272ad5016",
  "IdAPIUsuario": "2e98905a-d861-4669-9668-21741508adag",
  "GuidCampanha": "1198bc23-dd1e-4f62-9425-7299b7ae9f2e",
  "Telefone": "552199999999",
  "MsgTexto": "Teste",
  "TipoEnvio": "SMS"
}'

200400

{
  "message": "Ok",
  "IdAPIUsuario": "2e98905a-d861-4669-9668-21741508adag",
  "IdRetorno": "67a5ccc89c4e4886881d4913b323131d8ec"
}

Dados processados com sucesso

Criar Campanha de Voz a partir de Base64

Cria uma nova campanha de voz utilizando um arquivo de áudio enviado em Base64.

Body

requiredapplication/json

Dados necessários para criação da campanha de voz

Base64Audiostring

Áudio codificado em Base64

Example

NomeCampanhastring

Nome da campanha de voz

Example

APIKEYstring

Chave de API do usuário

Example

IdUsuarioAPIstring · uuid

Identificador único do usuário da API

Example

Responses

{
  "message": "Campanha de voz criada com sucesso.",
  "GuidCampanha": "b234fa7e-5290-44d3-bce2-2a3769f8baf1"
}

POST/api/v2/VoiceCampaign/createFromBase64

curl https://api.sendwork.com.br/api/v2/VoiceCampaign/createFromBase64   --request POST   --header 'Content-Type: application/json'   --data '{
  "Base64Audio": "SUQzAwAAAA...",
  "NomeCampanha": "Campanha Teste Voz",
  "APIKEY": "67a5ccc89c4e4886881d4913b331d8ec",
  "IdUsuarioAPI": "c582ffa8-5087-41d3-aae2-7919ae5852fc"
}'

200

{
  "message": "Campanha de voz criada com sucesso.",
  "GuidCampanha": "b234fa7e-5290-44d3-bce2-2a3769f8baf1"
}

Campanha criada com sucesso

Criar Campanha de Voz a partir de Arquivo

Cria uma nova campanha de voz utilizando um arquivo de áudio enviado via formulário multipart/form-data.

Body

requiredmultipart/form-data

Campos do formulário para criação da campanha de voz

Filestring · binary

Arquivo de áudio (formato mp3)

Example

NomeCampanhastring

Nome da campanha de voz

Example

APIKEYstring

Chave de API do usuário

Example

IdUsuarioAPIstring · uuid

Identificador único do usuário da API

Example

Responses

{
  "message": "Campanha de voz criada com sucesso.",
  "GuidCampanha": "b234fa7e-5290-44d3-bce2-2a3769f8baf1"
}

POST/api/v2/VoiceCampaign/createFromFile

curl https://api.sendwork.com.br/api/v2/VoiceCampaign/createFromFile   --request POST   --form 'File=@filename'   --form 'NomeCampanha=Campanha Teste Voz'   --form 'APIKEY=67a5ccc89c4e4886881d4913b331d8ec'   --form 'IdUsuarioAPI=c582ffa8-5087-41d3-aae2-7919ae5852fc'

200

{
  "message": "Campanha de voz criada com sucesso.",
  "GuidCampanha": "b234fa7e-5290-44d3-bce2-2a3769f8baf1"
}

Campanha criada com sucesso

TokenAuth

Cria uma nova campanha de token

POST

Cria uma nova campanha de autenticação por token

/api/v1/token/campaign

Solicita o envio de um token via SMS

POST

Envia um código de verificação via SMS

/api/v1/token/send

Valida o token informado

POST

Valida o código de verificação fornecido pelo usuário

/api/v1/token/validate