API para envio de mídias
Este módulo da documentação trata das APIs voltadas para o envio de mídias (como imagens, áudios, vídeos e documentos) através da plataforma. Ele mostra como integrar e utilizar esses recursos via URL ou upload direto, permitindo que sistemas externos enviem diferentes tipos de arquivos para atendimentos ou contatos.📁
📌 API Enviar Imagem por URL
API: Baileys
Envia uma imagem a partir de uma URL, com opção de legenda.
Verifique aqui os Pré-Requisitos para utilizar APIs
Endpoint POST
https://https://api.gpconnect.com.br/api/messages/sendURLImage
API
Utilize o código em requisições HTTPS com ferramentas como cURL ou bibliotecas de integração.
📌 Visão Geral
Este documento descreve como utilizar a API de envio de mensagens para enviar uma imagem via URL para um número de telefone através de uma requisição POST com cURL em PHP.
📤 Endpoint
URL:
POST https://https://api.gpconnect.com.br/api/messages/sendURLImage
🔐 Autenticação
A autenticação é feita via token Bearer.
Cabeçalho:
Authorization: Bearer {seutokenaqui}
📥 Parâmetros da Requisição
A requisição deve ser feita com o tipo de conteúdo application/json.
Corpo (JSON)
{
"number": "5511999999999",
"body": "https://s3.typebot.io/public/workspaces/clozv34id002ljx0fpagmqor4/typebots/clozv9d7f0004l50go6cgxv4u/blocks/undv5w2a81os520srvrb4tp5?v=1701958989883",
"mimeType": "image/jpeg",
"caption": "Caption"
}
💻 Exemplo de Código (PHP com cURL)
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://https://api.gpconnect.com.br/api/messages/sendURLImage',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => '{
"number": "5511999999999",
"body": "https://s3.typebot.io/public/workspaces/clozv34id002ljx0fpagmqor4/typebots/clozv9d7f0004l50go6cgxv4u/blocks/undv5w2a81os520srvrb4tp5?v=1701958989883",
"mimeType": "image/jpeg",
"caption": "Caption"
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'Authorization: Bearer {seutokenaqui}'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
✅ Resposta Esperada
Exemplo de Resposta (Sucesso)
{
"status": "success",
"message": "Imagem enviada com sucesso."
}
⚠️ Possíveis Erros
📌 API Enviar Áudio por URL
API: Baileys
Envia um áudio a partir de uma URL.
Verifique aqui os Pré-Requisitos para utilizar APIs
Endpoint POST
https://https://api.gpconnect.com.br/api/messages/sendURLAudio
📖 Documentação - Envio de Áudio via URL
Este endpoint permite o envio de arquivos de áudio através de uma URL utilizando uma requisição POST com dados em formato JSON.
Endpoint:
POST https://https://api.gpconnect.com.br/api/messages/sendURLAudio
Cabeçalhos obrigatórios:
Content-Type: application/json
Authorization: Bearer {seu_token_aqui}
Exemplo de Corpo da Requisição:
{
"number": "5511999999999", // Número de telefone do destinatário no formato internacional (DDI + DDD + número)
"body": "https://s3.typebot.io/public/workspaces/clozv34id002ljx0fpagmqor4/typebots/clozv9d7f0004l50go6cgxv4u/blocks/raycbyurlc6xybynm84b41mw?v=1701959327584", // URL direta do arquivo de áudio
"mimeType": "audio/mpeg", // Tipo MIME do áudio (ex: audio/mpeg, audio/ogg)
"ptt": true // Indica se o áudio deve ser enviado como mensagem de voz (PTT = Push-to-Talk)
}
Descrição dos Parâmetros:
number: Número de telefone de destino. Deve estar no formato internacional (ex: Brasil: 55 + DDD + número).
body: URL do áudio a ser enviado. Deve ser um link direto para o arquivo.
mimeType: Tipo do arquivo de áudio, conforme o padrão MIME.
ptt: Valor booleano. Se true, o áudio é enviado como mensagem de voz (modo walkie-talkie).
Resposta Esperada: A resposta será um objeto JSON contendo informações sobre o status do envio da mensagem.
Erros de autenticação, URL inválida ou tipos incorretos retornarão códigos HTTP apropriados como 400 ou 401.
📌API Enviar Vídeo por URL
API: Baileys
Envia um áudio a partir de uma URL, com opção de legenda.
Verifique aqui os Pré-Requisitos para utilizar APIs
Endpoint POST
https://https://api.gpconnect.com.br/api/messages/sendURLVideo
API
📖 Documentação - Envio de Vídeo via URL
Este endpoint permite o envio de arquivos de vídeo através de uma URL utilizando uma requisição POST com dados em formato JSON.
Endpoint:
POST https://https://api.gpconnect.com.br/api/messages/sendURLVideo
Cabeçalhos obrigatórios:
Content-Type: application/json
Authorization: Bearer {seu_token_aqui}
Exemplo de Corpo da Requisição:
{
"number": "5511999999999", // Número de telefone do destinatário no formato internacional (DDI + DDD + número)
"body": "https://s3.typebot.io/public/workspaces/clozv34id002ljx0fpagmqor4/typebots/clozv9d7f0004l50go6cgxv4u/blocks/f8z60ovfrdihw4x2n2jv1qxn?v=1701959544727", // URL direta do arquivo de vídeo
"caption": "Vídeo demonstrativo" // Legenda ou descrição que será exibida junto com o vídeo
}
Descrição dos Parâmetros:
number: Número de telefone de destino. Deve estar no formato internacional (ex: Brasil: 55 + DDD + número).
body: URL do vídeo a ser enviado. Deve ser um link direto para o arquivo.
caption: Texto opcional que acompanha o vídeo como legenda.
Resposta Esperada: A resposta será um objeto JSON contendo informações sobre o status do envio da mensagem.
Erros de autenticação, URL inválida ou outros problemas retornarão códigos HTTP apropriados como 400 ou 401.
📌 API Enviar Documento por URL
API: Baileys
Envia um documento a partir de uma URL, com opção de legenda.
Verifique aqui os Pré-Requisitos para utilizar APIs
Endpoint POST
https://https://api.gpconnect.com.br/api/messages/sendURLDocument
Copy
API
📖 Documentação - Envio de Documento via URL
Este endpoint permite o envio de documentos (como PDF, DOC, XLS etc.) através de uma URL utilizando uma requisição POST com dados em formato JSON.
Endpoint:
POST https://https://api.gpconnect.com.br/api/messages/sendURLDocument
Cabeçalhos obrigatórios:
Content-Type: application/json
Authorization: Bearer {seu_token_aqui}
Exemplo de Corpo da Requisição:
{
"number": "5511999999999", // Número de telefone do destinatário no formato internacional (DDI + DDD + número)
"body": "https://minhaurl.com.br/meuarquivo.pdf", // URL direta do documento a ser enviado
"fileName": "TESTE DE NOME", // Nome do arquivo que será exibido para o destinatário
"mimeType": "application/pdf", // Tipo MIME do documento (ex: application/pdf, application/msword)
"caption": "Caption" // Legenda ou descrição opcional que acompanha o documento
}
Descrição dos Parâmetros:
number: Número de telefone de destino. Deve estar no formato internacional (ex: Brasil: 55 + DDD + número).
body: URL do documento a ser enviado. Deve ser um link direto para o arquivo.
fileName: Nome que será exibido ao usuário como o nome do documento.
mimeType: Tipo do documento conforme o padrão MIME.
caption: Texto opcional que acompanha o documento como legenda.
Resposta Esperada: A resposta será um objeto JSON contendo informações sobre o status do envio da mensagem.
Em caso de erro (como autenticação inválida, URL incorreta ou tipo de arquivo não suportado), a API retornará um código de erro HTTP adequado (400, 401 etc.).
📌 API Enviar Arquivos
API: Baileys
Envia um arquivo a partir de uma URL, com opção de abrir ticket e direcionar à fila.
Verifique aqui os Pré-Requisitos para utilizar APIs
Endpoint POST
https://https://api.gpconnect.com.br/api/messages/send
API
📖 Documentação - Envio de Arquivos via Upload Direto
Este endpoint permite o envio de mídias (como imagens, PDFs, etc.) através de upload direto do arquivo, utilizando o formato multipart/form-data.
Endpoint:
POST https://https://api.gpconnect.com.br/api/messages/send
Cabeçalho obrigatório:
Authorization: Bearer {seu_token_aqui}
⚠ Obs: Não é necessário especificar Content-Type, pois o cURL define automaticamente ao usar multipart/form-data.
Exemplo de Corpo da Requisição (multipart):
{
“medias”: [arquivo enviado diretamente] // Arquivo físico (ex: imagem, PDF, etc.)
“number”: 5511999999999 // Número de telefone do destinatário (formato internacional)
“openTicket”: 0 // Define se abrirá um ticket (0 = não abre, 1 = abre)
“queueId”: 0 // ID da fila que receberá o ticket (caso “openTicket” = 1) // = 1 abre ticket , = 0 Não abre ticket (Caso seja igual a 1,e obrigatorio infomar o ID da fila
body: Teste // Mensagem de texto (aparece como legenda se media for imagem)
}
Descrição dos Parâmetros:
medias: Arquivo a ser enviado, usando CURLFile. Pode ser uma imagem, documento, etc.
number: Número do destinatário no formato internacional (ex: 55 + DDD + número).
openTicket: Define se a mensagem abrirá um novo ticket. 0 para não abrir, 1 para abrir.
queueId: Caso openTicket seja 1, define o ID da fila para onde o ticket será direcionado.
body: Texto que acompanha o envio. Em caso de mídia visual (como imagem), será mostrado como legenda.
Resposta Esperada: Retorna um objeto JSON com o status do envio da mensagem. Caso haja erro, a API retorna códigos HTTP como 400 (requisição inválida) ou 401 (não autorizado).