Skip to content

Funções Diversas

Buscar Contatos da Agenda

Lista todos os contatos da agenda do dispositivo

javascript
let response = await client.getAllContacts()

Retorno de sucesso

javascript
{
  session: 'Marketing',
  device: "551152204957",
  type: 'get-all-contacts',
  qt: 2,
  contacts: [
    {
      id: '552123919428',
      name: 'Alenii Venom',
      short: ''
    },
    {
      id: '556181590153',
      name: 'Joe Dutra',
      short: ''
    }
  ]
}

Retorno de erro

javascript
{
  session: 'Marketing',
  device: "551152204957",
  status: 404,
  type: 'get-all-contacts',
  message: 'message of erro'
}

Buscar Contatos Bloqueados

Lista todos os contatos bloqueados

javascript
let response = await client.getBlockList()

Retorno de sucesso

javascript
{
  session: 'Marketing',
  device: "551152204957",
  type: 'get-block-list',
  list: [ '5561986268199', '5561998745252' ]
}

Retorno de erro

javascript
{
  session: 'Marketing',
  device: "551152204957",
  status: 404,
  type: 'get-block-list',
  message: 'message of erro'
}

Informações do Dispositivo

Traz informações do dispositivo

javascript
let response = await client.getHostDevice()

Retorno de sucesso

javascript
{
  session: 'Marketing',
  device: "551152204957",
  status: 200,
  type: 'get-host-device',
  phone: '556181590153',
  image: "https://pps.whatsapp.net/v/t61.24694-24/254827313_500572874791871_6168181924916411415_n.jpg?stp=dst-jpg_s96x96&ccb=11-4&oh=5ee43eb4f1fe109b10ceba05292561aa&oe=622FF53D",
  pushName: 'Joe Dutra'
}

Retorno de erro

javascript
{
  session: 'Marketing',
  device: "551152204957",
  status: 404,
  type: 'get-host-device',
  message: 'message of erro'
}

Bloquear Contato

Bloqueia e Desbloqueia um contato

Bloquear

javascript
//number of chat
let response = await client.blockContact("5561981590153")

Desbloquear

javascript
//number of chat
let response = await client.unblockContact("5561981590153")

Retorno de sucesso

javascript
{
  session: 'Marketing',
  device: "551152204957",
  status: 200,
  type: 'block-contact',
}

Retorno de erro

javascript
{
  session: 'Marketing',
  device: "551152204957",
  status: 404,
  type: 'block-contact',
  message: 'message of erro'
}

Trazer Informações do Status

Exibe o status de um contato especifico.

javascript
//number of chat
let response = await client.getProfileStatus("5561981590153")

Retorno de sucesso

javascript
{
  session: 'Marketing',
  device: "551152204957",
  type: 'get-profile-status',
  status: 'Que Deus seja sempre louvado em nossas vidas'
}

Retorno de erro

javascript
{
  session: 'Marketing',
  device: "551152204957",
  status: 404,
  type: 'get-profile-status',
  message: 'message of erro'
}

Traz a Imagem do contato

Exibe a imagem do perfil do contato

javascript
//number of chat
let response = await client.getPicture("5561981590153")

Retorno de sucesso

javascript
{
    session: "1",
    device: "551152204957",
    status: 200,
    type: "get-picture",
    img: "https://pps.whatsapp.net/v/t61.24694-24/418935870_1492680228298036_3040916073525625274_n.jpg?stp=dst-jpg_s96x96&ccb=11-4&oh=01_Q5AaIBVNPGBqlnEYu_Ut8NtMUfx7Qs-G-gJnvhY_JvtYpMeP&oe=66414C35&_nc_sid=e6ed6c&_nc_cat=102",
    imgFull: "https://pps.whatsapp.net/v/t61.24694-24/418935870_1492680228298036_3040916073525625274_n.jpg?ccb=11-4&oh=01_Q5AaILuR6p01REsvwoHBKjWBMLJKFs_n-xGnLXvzX-zJ89RA&oe=66414C35&_nc_sid=e6ed6c&_nc_cat=102"
}

Retorno sem imagem ou sem permissão

javascript
{
    session: "1",
    device: "551152204957",
    status: 200,
    type: "get-picture",
    img: null,
    imgFull: null
}

Retorno de erro

javascript
{
  session: 'Marketing',
  device: "551152204957",
  status: 404,
  type: 'get-picture',
  message: 'message of erro'
}

Alterar Imagem do Perfil

Modifica a imagem do perfil ou do grupo

javascript
//number of chat, file local path
let response = await client.setPicture("5561981590153", "./image-profile.png")

Retorno de sucesso

javascript
{
  session: 'Marketing',
  status: 200,
  type: 'set-picture'
}

Retorno de erro

javascript
{
  session: 'Marketing',
  status: 404,
  type: 'set-picture',
  message: 'message of erro'
}

Verifica Número de Whatsapp

Checa se um número de telefone possuí o Whatsapp

javascript
//number of chat
let response = await client.getNumberProfile("5561981590153")

Retorno de sucesso

javascript
{
  session: 'Marketing',
  type: 'get-number-profile',
  id: '556181590153',
  isBusiness: false,
  exist: true
}

Retorno de erro

javascript
{
  session: 'Marketing',
  status: 404,
  type: 'get-number-profile',
  message: 'message of erro'
}

Atualizar Presença

Atualize sua presença para um determinado contato

Tipos de estado: a = disponível, c = digitando, r = gravando, p = pausado

javascript
//chat number, state: a, c, r, p
let response = await client.setPresence('556181590153', 'c');

Retorno de sucesso

javascript
{ 
  session: 'Marketing',
  status: 200, 
  type: 'set-presence' 
}

Retorno de erro

javascript
{
  session: 'Marketing',
  status: 404,
  type: 'set-presence',
  message: 'message of erro'
}

Mudar Nome do Perfil

Atualiza o nome no Whatsapp

javascript
// nome
let response = await client.setName("Orkestral");

Retorno de sucesso

javascript
{ 
  session: 'Marketing',
  status: 200, 
  type: 'set-name' 
}

Retorno de erro

javascript
{
  session: 'Marketing',
  status: 404,
  type: 'set-name',
  message: 'message of erro'
}

Mudar Status do Perfil

Atualiza o status no Whatsapp

javascript
// nome
let response = await client.setStatus('Viva la vida!');

Retorno de sucesso

javascript
{ 
  session: 'Marketing',
  status: 200, 
  type: 'set-status' 
}

Retorno de erro

javascript
{
  session: 'Marketing',
  status: 404,
  type: 'set-status',
  message: 'message of erro'
}

All rights reserved to Orkestral LLC