Configurar delay entre mensagens async

POST /instance/updateDelaySettings

Configura o intervalo de tempo entre mensagens diretas enviadas com async=true.

Detalhes

  • Configuração aplicada apenas à fila interna de mensagens async
  • Afeta mensagens enviadas pelos endpoints de envio com async=true
  • Não afeta campanhas do sender (/sender/*)
  • Delay mínimo (msg_delay_min): 0 ou mais segundos (0 = sem delay)
  • Delay máximo (msg_delay_max): se menor que min, será ajustado para o mesmo valor de min
  • Sistema ajusta automaticamente valores negativos para 0

Exemplo

{
  "msg_delay_min": 0,
  "msg_delay_max": 2
}

Autenticação

[
  {
    "token": []
  }
]
{
  "token": {
    "name": "token",
    "type": "apiKey",
    "in": "header"
  }
}

Corpo da requisição

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "msg_delay_min": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "Delay mínimo em segundos (0 = sem delay)",
            "example": 0
          },
          "msg_delay_max": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "Delay máximo em segundos",
            "example": 2
          }
        },
        "required": [
          "msg_delay_min",
          "msg_delay_max"
        ]
      }
    }
  }
}

Respostas

{
  "200": {
    "description": "Sucesso",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "instance": {
              "$ref": "#/components/schemas/Instance"
            }
          }
        }
      }
    }
  },
  "400": {
    "description": "Requisição inválida",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "string",
              "example": "Invalid request payload"
            }
          }
        }
      }
    }
  },
  "401": {
    "description": "Token inválido ou expirado",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "string",
              "example": "client not found"
            }
          }
        }
      }
    }
  },
  "500": {
    "description": "Erro interno do servidor",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "string",
              "example": "Failed to update delay settings"
            }
          }
        }
      }
    }
  }
}

#/components/schemas/Instance

{
  "type": "object",
  "description": "Representa uma instância do WhatsApp",
  "properties": {
    "id": {
      "type": "string",
      "description": "Identificador opaco gerado pelo servidor. Não presuma formato UUID."
    },
    "token": {
      "type": "string",
      "description": "Token de autenticação da instância"
    },
    "status": {
      "type": "string",
      "description": "Status atual da conexão",
      "enum": [
        "disconnected",
        "connecting",
        "connected",
        "hibernated"
      ]
    },
    "paircode": {
      "type": "string",
      "description": "Código de pareamento"
    },
    "qrcode": {
      "type": "string",
      "description": "QR Code em base64 para autenticação"
    },
    "name": {
      "type": "string",
      "description": "Nome da instância"
    },
    "profileName": {
      "type": "string",
      "description": "Nome do perfil WhatsApp"
    },
    "profilePicUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL da foto do perfil"
    },
    "isBusiness": {
      "type": "boolean",
      "description": "Indica se é uma conta business"
    },
    "plataform": {
      "type": "string",
      "description": "Plataforma de origem (iOS/Android/Web)"
    },
    "systemName": {
      "type": "string",
      "description": "Nome do sistema operacional"
    },
    "owner": {
      "type": "string",
      "description": "Proprietário da instância"
    },
    "current_presence": {
      "type": "string",
      "description": "Status atual de presença da instância (campo não persistido)",
      "enum": [
        "available",
        "unavailable"
      ],
      "example": "available"
    },
    "lastDisconnect": {
      "type": "string",
      "description": "Data/hora textual da última desconexão"
    },
    "lastDisconnectReason": {
      "type": "string",
      "description": "Motivo da última desconexão"
    },
    "adminField01": {
      "type": "string",
      "description": "Campo administrativo 01"
    },
    "adminField02": {
      "type": "string",
      "description": "Campo administrativo 02"
    },
    "openai_apikey": {
      "type": "string",
      "description": "Chave da API OpenAI"
    },
    "chatbot_enabled": {
      "type": "boolean",
      "description": "Habilitar chatbot automático"
    },
    "chatbot_ignoreGroups": {
      "type": "boolean",
      "description": "Ignorar mensagens de grupos"
    },
    "chatbot_stopConversation": {
      "type": "string",
      "description": "Palavra-chave para parar conversa"
    },
    "chatbot_stopMinutes": {
      "type": "integer",
      "description": "Por quanto tempo ficará pausado o chatbot ao usar stop conversation"
    },
    "chatbot_stopWhenYouSendMsg": {
      "type": "integer",
      "description": "Por quanto tempo ficará pausada a conversa quando você enviar mensagem manualmente"
    },
    "fieldsMap": {
      "type": "object",
      "description": "Mapa de campos customizados da instância (quando presente)",
      "additionalProperties": true
    },
    "currentTime": {
      "type": "string",
      "description": "Horário atual retornado pela API"
    },
    "created": {
      "type": "string",
      "description": "Data de criação retornada pela API. Trate o valor como texto; o formato pode variar."
    },
    "updated": {
      "type": "string",
      "description": "Data da última atualização retornada pela API. Trate o valor como texto; o formato pode variar."
    }
  },
  "example": {
    "id": "i91011ijkl",
    "token": "abc123xyz",
    "status": "connected",
    "paircode": "1234-5678",
    "qrcode": "data:image/png;base64,iVBORw0KGg...",
    "name": "Instância Principal",
    "profileName": "Loja ABC",
    "profilePicUrl": "https://example.com/profile.jpg",
    "isBusiness": true,
    "plataform": "Android",
    "systemName": "uazapi",
    "owner": "user@example.com",
    "lastDisconnect": "2025-01-24T14:00:00Z",
    "lastDisconnectReason": "Network error",
    "adminField01": "custom_data",
    "openai_apikey": "sk-...xyz",
    "chatbot_enabled": true,
    "chatbot_ignoreGroups": true,
    "chatbot_stopConversation": "parar",
    "chatbot_stopMinutes": 60,
    "created": "2025-01-24T14:00:00Z",
    "updated": "2025-01-24T14:30:00Z",
    "currentPresence": "available"
  }
}

Guias relacionados

Autenticação · Erros e retries · Server URL