Endpoint: Enviar Mensagem
Este endpoint é usado para enviar uma mensagem para um número de telefone em uma conexão específica.
Requisição
POST /send/{id}
Parâmetros de entrada
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | string | O número da conexão para enviar a mensagem |
Headers
Além dos parâmetros de entrada e do corpo da requisição, a requisição deve incluir os seguintes headers:
| Header | Descrição |
|---|---|
| Content-Type | O tipo de conteúdo da requisição, deve ser "application/json" |
| Authorization | O token de autorização da conexão no formato "Bearer {token da conexão}" |
Corpo da Requisição
A requisição deve incluir o seguinte corpo (em formato JSON):
{
"message": "string",
"number": "string"
}
| Propriedade | Tipo | Descrição |
|---|---|---|
| message | string | A mensagem a ser enviada |
| number | string | O número de telefone para o qual a mensagem será enviada |
Exemplo de Requisição
POST /send/{id} HTTP/1.1
Host: dev.solubot.com.br
Content-Type: application/json
Authorization: Bearer <token da conexão>
{
"message": "Exemplo de mensagem",
"number": "1234567890"
}
Resposta de Sucesso
Em caso de sucesso, a requisição retornará o código de status 200 OK. Nenhum conteúdo adicional é retornado.
Resposta de Erro
Em caso de falha na requisição, serão retornados códigos de status diferentes de 200. A resposta de erro pode conter informações adicionais no corpo da resposta. Os possíveis erros são:
| Código | Mensagem | Descrição |
|---|---|---|
| 400 | INVALID_NUMBER | Número de Whatsapp inválido. |
| 400 | ERR_CONNECTION_NOT_INITIALIZED | A conexão não foi inicializada ou está incompleta. |
| 401 | ERR_NO_PERMISSION | O usuário não possui permissão para acessar a conexão. |
| 401 | NO_ACCESS_TOKEN | Nenhum token de autorização fornecido. É necessário fornecer um token válido para acessar a conexão. |
| 403 | INVALID_TOKEN | O token de autorização fornecido é inválido ou expirou. É necessário fornecer um token válido para acessar a conexão. |
| 404 | ERR_NO_CONNECTION_FOUND | Nenhuma conexão encontrada com o ID fornecido. |
Uso da Requisição
- O cliente envia uma requisição POST para
/send/{id}para enviar uma mensagem para um número de telefone em uma conexão específica. - A requisição deve incluir o header "Content-Type" com o valor "application/json" e o header "Authorization" com o token de autorização no formato "Bearer {token da conexão}".
- O corpo da requisição deve conter a propriedade "message" com a mensagem a ser enviada e a propriedade "phone" com o número de telefone de destino.
- O servidor processa a requisição e envia a mensagem para o número de telefone especificado na conexão correspondente ao ID fornecido.
- Em caso de sucesso, o servidor retorna o código de status 200 OK.
- Caso ocorra um erro, o servidor retorna um código de status apropriado junto com uma mensagem de erro no corpo da resposta.