Criar Canal

Metodo

POST https://oapi.ogmma.com.br/v1/channels

Conceituacao

Cria um novo canal na sua instituicao. Apos a criacao, o canal estara com status DISCONNECTED e precisara ser conectado atraves do endpoint de conexao.

Atributos

Header

Atributo	Tipo	Obrigatorio	Descricao
Authorization	string	Sim	Bearer {API_KEY} - Chave de autenticacao da API
Content-Type	string	Sim	application/json

Body

Atributo	Tipo	Obrigatorio	Descricao
name	string	Sim	Nome do canal. Minimo 3 caracteres, maximo 100 caracteres.
type	string	Sim	Tipo do canal. Valores: WHATSAPP_BAILEYS ou WHATSAPP_WABA.

Request

cURL

curl -X POST "https://oapi.ogmma.com.br/v1/channels" \
  -H "Authorization: Bearer {API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Atendimento Principal",
    "type": "WHATSAPP_BAILEYS"
  }'

Node.js

const axios = require('axios');

const response = await axios.post(
  'https://oapi.ogmma.com.br/v1/channels',
  {
    name: 'Atendimento Principal',
    type: 'WHATSAPP_BAILEYS'
  },
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.post(
    'https://oapi.ogmma.com.br/v1/channels',
    json={
        'name': 'Atendimento Principal',
        'type': 'WHATSAPP_BAILEYS'
    },
    headers={
        'Authorization': 'Bearer {API_KEY}',
        'Content-Type': 'application/json'
    }
)

print(response.json())

Response

201 - Canal criado com sucesso

{
  "data": {
    "id": "6650a1b2c3d4e5f6a7b8c9d0",
    "name": "Atendimento Principal",
    "type": "WHATSAPP_BAILEYS",
    "status": "DISCONNECTED",
    "phone": null,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z"
  }
}

400 - Dados invalidos

{
  "message": "Dados de entrada invalidos.",
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "field": "name",
      "message": "O nome deve ter pelo menos 3 caracteres."
    }
  ]
}

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"
}