{
  "components": {
    "schemas": {
      "Atendimentos": {
        "properties": {
          "atendimentos": {
            "items": {
              "additionalProperties": {
                "type": "string"
              },
              "type": "object"
            },
            "type": "array"
          },
          "total": {
            "type": "integer"
          }
        },
        "type": "object"
      },
      "Canais": {
        "properties": {
          "canais": {
            "items": {
              "additionalProperties": {
                "type": "string"
              },
              "type": "object"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "Contato": {
        "properties": {
          "criado_em": {
            "format": "date-time",
            "type": "string"
          },
          "etiquetas": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "id": {
            "type": "string"
          },
          "nome": {
            "type": "string"
          },
          "telefone": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ContatoEntrada": {
        "properties": {
          "etiquetas": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "nome": {
            "type": "string"
          },
          "telefone": {
            "type": "string"
          }
        },
        "required": [
          "telefone"
        ],
        "type": "object"
      },
      "Contatos": {
        "properties": {
          "contatos": {
            "items": {
              "$ref": "#/components/schemas/Contato"
            },
            "type": "array"
          },
          "total": {
            "type": "integer"
          }
        },
        "type": "object"
      },
      "Erro": {
        "properties": {
          "erro": {
            "type": "string"
          },
          "mensagem": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "MensagemEntrada": {
        "properties": {
          "canal_id": {
            "format": "uuid",
            "type": "string"
          },
          "fila_id": {
            "format": "uuid",
            "type": "string"
          },
          "nome": {
            "type": "string"
          },
          "para": {
            "type": "string"
          },
          "texto": {
            "maxLength": 4096,
            "type": "string"
          }
        },
        "required": [
          "para",
          "texto"
        ],
        "type": "object"
      },
      "MensagemEnviada": {
        "properties": {
          "atendimento_id": {
            "type": "string"
          },
          "canal_id": {
            "type": "string"
          },
          "contato_id": {
            "type": "string"
          },
          "enviada_em": {
            "format": "date-time",
            "type": "string"
          },
          "estado": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "para": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "Mensagens": {
        "properties": {
          "mensagens": {
            "items": {
              "additionalProperties": {
                "type": "string"
              },
              "type": "object"
            },
            "type": "array"
          },
          "total": {
            "type": "integer"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "chave": {
        "bearerFormat": "omn_…",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "description": "Envie mensagens de WhatsApp, cadastre contatos e acompanhe os atendimentos da empresa no Primux Omni. Autenticação por chave Bearer (omn_…) criada no console. Chaves de leitura só usam GET.",
    "title": "API de integração do Primux Omni",
    "version": "1.0.0"
  },
  "openapi": "3.0.3",
  "paths": {
    "/v1/omni/atendimentos": {
      "get": {
        "parameters": [
          {
            "description": "ativo, espera ou resolvido.",
            "in": "query",
            "name": "estado",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Padrão 50, máximo 100.",
            "in": "query",
            "name": "limite",
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "Quantos itens pular.",
            "in": "query",
            "name": "deslocamento",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Atendimentos"
                }
              }
            },
            "description": "Atendimentos"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "502": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          }
        },
        "summary": "Listar atendimentos"
      }
    },
    "/v1/omni/atendimentos/{id}/mensagens": {
      "get": {
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          },
          {
            "description": "Padrão 50, máximo 100.",
            "in": "query",
            "name": "limite",
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "Quantos itens pular.",
            "in": "query",
            "name": "deslocamento",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Mensagens"
                }
              }
            },
            "description": "Mensagens"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "502": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          }
        },
        "summary": "Mensagens de um atendimento"
      }
    },
    "/v1/omni/canais": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Canais"
                }
              }
            },
            "description": "Canais"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "502": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          }
        },
        "summary": "Listar canais (conexões)"
      }
    },
    "/v1/omni/contatos": {
      "get": {
        "parameters": [
          {
            "description": "Nome ou telefone.",
            "in": "query",
            "name": "busca",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Padrão 50, máximo 100.",
            "in": "query",
            "name": "limite",
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "Quantos itens pular.",
            "in": "query",
            "name": "deslocamento",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Contatos"
                }
              }
            },
            "description": "Contatos"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "502": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          }
        },
        "summary": "Listar contatos"
      },
      "post": {
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ContatoEntrada"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Contato"
                }
              }
            },
            "description": "Contato"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "502": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          }
        },
        "summary": "Criar contato (chave com escrita); se o telefone já existir devolve o contato (200)"
      }
    },
    "/v1/omni/contatos/{id}": {
      "get": {
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Contato"
                }
              }
            },
            "description": "Contato"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "502": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          }
        },
        "summary": "Ver um contato"
      }
    },
    "/v1/omni/eu": {
      "get": {
        "responses": {
          "200": {
            "description": "Empresa e chave"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "502": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          }
        },
        "summary": "Empresa e chave em uso"
      }
    },
    "/v1/omni/mensagens": {
      "post": {
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MensagemEntrada"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MensagemEnviada"
                }
              }
            },
            "description": "MensagemEnviada"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          },
          "502": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Erro"
                }
              }
            },
            "description": "Erro"
          }
        },
        "summary": "Enviar mensagem de texto (chave com escrita)"
      }
    }
  },
  "security": [
    {
      "chave": []
    }
  ],
  "servers": [
    {
      "url": "https://dev-api.primux.cloud"
    }
  ]
}