Listar Mensagens do Sandbox

Metodo

GET https://oapi.ogmma.com.br/v1/sandbox/messages

Conceituacao

Retorna a lista paginada de todas as mensagens enviadas e recebidas no ambiente sandbox. Utilize este endpoint para verificar o historico de testes e validar o comportamento da sua integracao.

Voce pode filtrar as mensagens por direcao (INBOUND ou OUTBOUND) para analisar separadamente as mensagens enviadas e as mensagens simuladas de entrada.

Limpar dados do Sandbox

Para remover todas as mensagens e dados de teste do sandbox, utilize o endpoint:

DELETE https://oapi.ogmma.com.br/v1/sandbox/data

Esta acao remove permanentemente todas as mensagens, conversas e dados de teste da sua instituicao no sandbox. Essa operacao e irreversivel.

Atributos

Header

Atributo	Tipo	Obrigatorio	Descricao
Authorization	string	Sim	Bearer {API_KEY} - Chave de autenticacao da API (prefixo oapi_sk_test_)

Query Parameters

Atributo	Tipo	Obrigatorio	Descricao
page	number	Nao	Numero da pagina. Padrao: 1
limit	number	Nao	Quantidade de registros por pagina. Padrao: 20, maximo: 100
direction	string	Nao	Direcao da mensagem. Valores: INBOUND, OUTBOUND

Request

cURL

curl -X GET "https://oapi.ogmma.com.br/v1/sandbox/messages?page=1&limit=20&direction=OUTBOUND" \
  -H "Authorization: Bearer {API_KEY}"

Node.js

const axios = require('axios');

const response = await axios.get(
  'https://oapi.ogmma.com.br/v1/sandbox/messages',
  {
    params: {
      page: 1,
      limit: 20,
      direction: 'OUTBOUND'
    },
    headers: {
      'Authorization': 'Bearer {API_KEY}'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.get(
    'https://oapi.ogmma.com.br/v1/sandbox/messages',
    params={
        'page': 1,
        'limit': 20,
        'direction': 'OUTBOUND'
    },
    headers={
        'Authorization': 'Bearer {API_KEY}'
    }
)

print(response.json())

Response

200 - Sucesso

{
  "success": true,
  "data": [
    {
      "id": "msg_sandbox_6650a1b2c3d4e5f6a7b8c9d0",
      "direction": "OUTBOUND",
      "to": "5511999998888",
      "type": "text",
      "content": {
        "text": "Ola! Esta e uma mensagem de teste do sandbox."
      },
      "status": "DELIVERED",
      "simulatedDelivery": true,
      "webhookFired": true,
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "id": "msg_sandbox_6650a1b2c3d4e5f6a7b8c9d1",
      "direction": "INBOUND",
      "from": "5511988887777",
      "type": "text",
      "content": {
        "text": "Mensagem simulada de entrada"
      },
      "status": "RECEIVED",
      "createdAt": "2024-01-15T10:32:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 2,
    "totalPages": 1
  }
}

401 - Nao autorizado

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

429 - Rate limit excedido

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

---

Limpar Dados do Sandbox

Metodo

DELETE https://oapi.ogmma.com.br/v1/sandbox/data

Request

cURL

curl -X DELETE "https://oapi.ogmma.com.br/v1/sandbox/data" \
  -H "Authorization: Bearer {API_KEY}"

Node.js

const axios = require('axios');

const response = await axios.delete(
  'https://oapi.ogmma.com.br/v1/sandbox/data',
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.delete(
    'https://oapi.ogmma.com.br/v1/sandbox/data',
    headers={
        'Authorization': 'Bearer {API_KEY}'
    }
)

print(response.json())

Response

200 - Dados removidos com sucesso

{
  "success": true,
  "data": {
    "messagesDeleted": 42,
    "conversationsDeleted": 5
  }
}

401 - Nao autorizado

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

Atencao

A limpeza dos dados do sandbox e irreversivel. Todas as mensagens, conversas e dados de teste serao permanentemente removidos.