Neste tópico, abordamos como você pode trocar a imagem de perfil da sua instância.
Para isso, basta enviar uma requisição PUT para a seguinte URL:
URL Base: https://apiwhatsappweb.com/api/config/image
Para autenticar as solicitações, você deve incluir a chave API (apiKey) e a identificação da instância Id (identificação) no cabeçalho (Header).
{
"apiKey": "Sua chave API aqui",
"id": "A identificação da instância aqui"
}
O corpo da requisição deve ser um objeto JSON com a seguinte estrutura:
{
"image": "imageFile" // Envie a imagem no corpo
}
A API pode responder com as seguintes mensagens:
✅ Resposta de Sucesso:
{
"200": { "success": "Image changed" }
} // Imagem trocada com sucesso
❌ Erro: Imagem não encontrada
{
"500": { "error": "No image provided. Please upload a file, send a Base64 string, or provide a URL." }
}
❌ Erro: Formato de imagem inválido
{
"500": { "error": "Image format error" }
}
❌ Erro: Instância não encontrada
{
"400": { "error": "Instance not found" }
} // Verifique os dados da instância
Neste tópico, abordamos como você pode ativar a leitura automática das mensagens na Instância.
Envie uma requisição POST para a seguinte URL para ativar a leitura automática:
URL Base: https://apiwhatsappweb.com/api/config/automatic
Para autenticar as solicitações, você deve incluir a chave API (apiKey) e a identificação da instância ID no cabeçalho (Header).
{
"apiKey": "Sua chave API aqui",
"id": "A identificação da instância aqui"
}
O corpo da requisição deve ser um objeto JSON com a seguinte estrutura:
{
"read": true // Envie true para ativar a leitura automática e false para desativar
}
A API pode retornar as seguintes respostas:
Resposta de Sucesso:
{
"200": { "success": "Automatic reading Updated" }
} // Leitura automática atualizada
Erro de Formato:
{
"500": { "error": "Body in wrong format" }
} // Corpo da requisição em formato incorreto
Instância não encontrada:
{
"400": { "error": "instance not found" }
} // Instância não encontrada, verifique os dados
Neste tópico, abordamos como você pode trocar o nome da sua conta na Instância.
Envie uma requisição POST para o seguinte URL:
Essa API permite trocar o nome do perfil do WhatsApp através de uma requisição POST.
URL Base: https://apiwhatsappweb.com/api/config/name
Para autenticar as solicitações, você deve incluir a chave API (apiKey) e a identificação da instância Id (identificação) no cabeçalho (Header).
{
"apiKey": "Sua chave Api aqui",
"id": "A identificação da instância aqui"
}
O corpo da requisição deve ser um objeto JSON com a seguinte estrutura:
{
"name": "Jonatan" // Envie o novo nome para a conta
}
A resposta pode ser uma das seguintes mensagens:
Resposta 1 (Sucesso):
{
"200": { "success": "Name Updated" }
} // Nome atualizado
Resposta 2 (Erro no formato do corpo):
{
"500": { "error": "Body in wrong format" }
} // Corpo da requisição em formato errado
Resposta 3 (Instância não encontrada):
{
"400": { "error": "Instance not found" }
} // Instância não encontrada, verifique os dados
Neste tópico, abordamos como você pode trocar a descrição da sua conta na Instância.
Envie uma requisição POST para a seguinte URL:
URL Base: https://apiwhatsappweb.com/api/config/description
Para autenticar as solicitações, você deve incluir a chave API (apiKey) e a identificação da instância Id (identificação) no cabeçalho (Header).
{
"apiKey": "Sua chave Api aqui",
"id": "A identificação da instância aqui"
}
O corpo da requisição deve ser um objeto JSON com a seguinte estrutura:
{
"description": "This is my small store on WhatsApp"
}
A resposta pode ser uma das seguintes mensagens:
Resposta 1:
{
"200": { "success": "description Updated" }
} // Nome atualizado
Resposta 2:
{
"500": { "error": "Body in wrong format" }
} // Corpo em formato errado
Resposta 3:
{
"400": { "error": "instance not found" }
} // Instância não encontrada, verifique os dados
Neste tópico, abordamos como você pode receber o QR-CODE da Instância via API.
Envie uma requisição POST para o seguinte URL:
URL Base:
https://apiwhatsappweb.com/api/config/qr
Para autenticar as solicitações, inclua a chave API (apiKey) e a identificação da instância Id (identificação) no cabeçalho (Header).
{
"apiKey": "Sua chave Api aqui",
"id": "A identificação da instância aqui"
}
Você receberá como resposta o QR-CODE:
{
"200": { "success": "QR-CODE sent", "QR": "base64" } // Resposta em formato BASE64
}
Atenção!
Se a instância não for encontrada, você receberá o erro abaixo. Verifique se os dados estão corretos.
{
"400": { "error": "instance not found" }
}
Neste tópico, abordamos como você pode desconectar a Instância via API.
Envie uma requisição POST para a seguinte URL para desconectar a instância do WhatsApp.
URL: https://apiwhatsappweb.com/api/config/disconnect
Para autenticar as solicitações, inclua a Chave API (apiKey) e a Identificação da Instância (id) no cabeçalho (Header).
{
"apiKey": "Sua chave API aqui",
"id": "A identificação da instância aqui"
}
A API pode retornar as seguintes respostas:
Instância desconectada:
{
"200": { "success": "instance disconnected" }
}
Instância já estava desconectada:
{
"200": { "success": "instance was already disconnected" }
}
Instância não encontrada:
{
"400": { "error": "instance not found" }
}
Neste tópico, abordamos como verificar o status da Instância via API.
Para obter o status da instância, envie uma requisição POST para a seguinte URL:
URL: https://apiwhatsappweb.com/api/config/status
Para autenticar as solicitações, inclua a Chave API (apiKey) e a Identificação da Instância (id) no cabeçalho (Header).
{
"apiKey": "Sua chave API aqui",
"id": "A identificação da instância aqui"
}
A API pode retornar as seguintes respostas:
✅ Instância está ativa:
{
"200": { "success": "Instance active" }
}
⚠️ Instância está desconectada:
{
"200": { "success": "Instance inactive" }
}
❌ Instância não encontrada:
{
"400": { "error": "Instance not found" }
}