Enviar vídeo

curl --request POST \
  --url https://api.omni.z-api.io/v1/channels/{channelId}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipient": {
    "identifier": "5511999999999"
  },
  "content": {
    "type": "VIDEO",
    "attachments": [
      {
        "url": "https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4",
        "caption": "Confira esse vídeo!"
      }
    ]
  }
}
'

import requests

url = "https://api.omni.z-api.io/v1/channels/{channelId}/messages"

payload = {
    "recipient": { "identifier": "5511999999999" },
    "content": {
        "type": "VIDEO",
        "attachments": [
            {
                "url": "https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4",
                "caption": "Confira esse vídeo!"
            }
        ]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    recipient: {identifier: '5511999999999'},
    content: {
      type: 'VIDEO',
      attachments: [
        {
          url: 'https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4',
          caption: 'Confira esse vídeo!'
        }
      ]
    }
  })
};

fetch('https://api.omni.z-api.io/v1/channels/{channelId}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.omni.z-api.io/v1/channels/{channelId}/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'recipient' => [
        'identifier' => '5511999999999'
    ],
    'content' => [
        'type' => 'VIDEO',
        'attachments' => [
                [
                                'url' => 'https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4',
                                'caption' => 'Confira esse vídeo!'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omni.z-api.io/v1/channels/{channelId}/messages"

	payload := strings.NewReader("{\n  \"recipient\": {\n    \"identifier\": \"5511999999999\"\n  },\n  \"content\": {\n    \"type\": \"VIDEO\",\n    \"attachments\": [\n      {\n        \"url\": \"https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4\",\n        \"caption\": \"Confira esse vídeo!\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.omni.z-api.io/v1/channels/{channelId}/messages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recipient\": {\n    \"identifier\": \"5511999999999\"\n  },\n  \"content\": {\n    \"type\": \"VIDEO\",\n    \"attachments\": [\n      {\n        \"url\": \"https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4\",\n        \"caption\": \"Confira esse vídeo!\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.omni.z-api.io/v1/channels/{channelId}/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recipient\": {\n    \"identifier\": \"5511999999999\"\n  },\n  \"content\": {\n    \"type\": \"VIDEO\",\n    \"attachments\": [\n      {\n        \"url\": \"https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4\",\n        \"caption\": \"Confira esse vídeo!\"\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "messageId": "wamid.HBgNNTU0NDk3MDUwNzg1FQIAERgSM0"
}

{
  "error": 401,
  "message": "Unauthorized"
}

POST

channels

{channelId}

messages

Enviar vídeo

curl --request POST \
  --url https://api.omni.z-api.io/v1/channels/{channelId}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipient": {
    "identifier": "5511999999999"
  },
  "content": {
    "type": "VIDEO",
    "attachments": [
      {
        "url": "https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4",
        "caption": "Confira esse vídeo!"
      }
    ]
  }
}
'

import requests

url = "https://api.omni.z-api.io/v1/channels/{channelId}/messages"

payload = {
    "recipient": { "identifier": "5511999999999" },
    "content": {
        "type": "VIDEO",
        "attachments": [
            {
                "url": "https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4",
                "caption": "Confira esse vídeo!"
            }
        ]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    recipient: {identifier: '5511999999999'},
    content: {
      type: 'VIDEO',
      attachments: [
        {
          url: 'https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4',
          caption: 'Confira esse vídeo!'
        }
      ]
    }
  })
};

fetch('https://api.omni.z-api.io/v1/channels/{channelId}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.omni.z-api.io/v1/channels/{channelId}/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'recipient' => [
        'identifier' => '5511999999999'
    ],
    'content' => [
        'type' => 'VIDEO',
        'attachments' => [
                [
                                'url' => 'https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4',
                                'caption' => 'Confira esse vídeo!'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omni.z-api.io/v1/channels/{channelId}/messages"

	payload := strings.NewReader("{\n  \"recipient\": {\n    \"identifier\": \"5511999999999\"\n  },\n  \"content\": {\n    \"type\": \"VIDEO\",\n    \"attachments\": [\n      {\n        \"url\": \"https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4\",\n        \"caption\": \"Confira esse vídeo!\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.omni.z-api.io/v1/channels/{channelId}/messages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recipient\": {\n    \"identifier\": \"5511999999999\"\n  },\n  \"content\": {\n    \"type\": \"VIDEO\",\n    \"attachments\": [\n      {\n        \"url\": \"https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4\",\n        \"caption\": \"Confira esse vídeo!\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.omni.z-api.io/v1/channels/{channelId}/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recipient\": {\n    \"identifier\": \"5511999999999\"\n  },\n  \"content\": {\n    \"type\": \"VIDEO\",\n    \"attachments\": [\n      {\n        \"url\": \"https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4\",\n        \"caption\": \"Confira esse vídeo!\"\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "messageId": "wamid.HBgNNTU0NDk3MDUwNzg1FQIAERgSM0"
}

{
  "error": 401,
  "message": "Unauthorized"
}

Conceituação

Envia uma mensagem com vídeo para um contato. O campo content.type deve ser VIDEO e o vídeo é enviado via URL no array attachments. Opcionalmente, você pode incluir uma caption (legenda) junto ao vídeo.

Detalhes da regra do WhatsApp Oficial em janela de conversa. Veja a matriz de capacidades para todos os canais.

Autorizações

Authorization

string

header

obrigatório

Secret Key gerada no painel de Segurança do Omni Z-API

Parâmetros de caminho

channelId

string

obrigatório

ID do canal

Exemplo:

"SEU_CHANNEL_ID"

Corpo

application/json

recipient

object

obrigatório

Show child attributes

content

object

obrigatório

Show child attributes

Resposta

Mensagem enviada com sucesso

messageId

string

ID da mensagem enviada

Canais

Mensagens

Templates (WhatsApp)

Flows (WhatsApp)

Webhooks

Enviar vídeo

Conceituação

Autorizações

Parâmetros de caminho

Corpo

Resposta

​Conceituação

Autorizações

Parâmetros de caminho

Corpo

Resposta

Conceituação