Pular para o conteúdo principal

Enviar Video

Metodo

POST https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/video

Conceituacao

Envia uma mensagem de video para um numero de telefone atraves de um canal conectado. O video deve ser enviado por URL publica acessivel. Opcionalmente, uma legenda pode ser adicionada.

Formatos suportados

FormatoExtensao
MP4.mp4
3GP.3gp

Limites

  • Tamanho maximo: 16MB
  • Videos maiores serao rejeitados com erro 400.

Atributos

AtributoTipoObrigatorioDescricao
AuthorizationstringSimBearer {API_KEY} - Chave de autenticacao da API
Content-TypestringSimapplication/json

Path Parameters

AtributoTipoObrigatorioDescricao
channelIdstringSimID do canal pelo qual a mensagem sera enviada.

Body

AtributoTipoObrigatorioDescricao
tostringSimNumero do destinatario no formato DDI+DDD+NUM.
videoUrlstringSimURL publica do video.
captionstringNaoLegenda do video. Maximo 1024 caracteres.
fileNamestringNaoNome do arquivo do video.
mimeTypestringNaoTipo MIME do video (ex: video/mp4).
fileSizenumberNaoTamanho do arquivo em bytes.

Request

curl -X POST "https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/video" \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"to": "5511999998888",
"videoUrl": "https://exemplo.com/video-tutorial.mp4",
"caption": "Assista ao tutorial completo"
}'

Response

202 - Aceito

{
"success": true,
"message": "Mensagem enfileirada para envio"
}

400 - Dados invalidos

{
"message": "Dados de entrada invalidos.",
"code": "VALIDATION_ERROR",
"errors": [
{
"field": "videoUrl",
"message": "A URL do video e obrigatoria."
}
]
}

401 - Nao autorizado

{
"message": "Token de autenticacao invalido ou ausente.",
"code": "UNAUTHORIZED"
}

429 - Rate limit excedido

{
"message": "Limite de requisicoes excedido. Tente novamente em alguns segundos.",
"code": "RATE_LIMIT_EXCEEDED"
}
Dica

Para uma melhor experiencia do destinatario, utilize videos no formato MP4 com codec H.264. Este formato possui a maior compatibilidade entre dispositivos.