culusms

culusms

Um SDK feito para o envio de sms usando o serviço culusms.com

• Apresentação
• Instalação
• Primeiros passos
• Mensagens
  • Enviar
  • Pendentes
  • Enviadas
  • Recebidas
• Dispositivos
  • Listas todos
  • Listar um
• Livro de endereços
  • Criar grupo
  • Listar grupos
  • Criar contacto
  • Listar contacto
  • Eliminar grupo
  • Eliminar contacto

Apresentação

O serviço culusms.com permite usar o teu telemovel como um gateway de envio de sms, como se estivesses a enviar a sms manualmente(podendo automatizar com este modulo), dai que a taxa para o envio das mensagens é debitada directamente na tua conta móvel. Para que o teu celular esteja habilitado como gateway, você precisa ter uma conta no culusms.com e depois instalar o apk no teu celular e seguir as instruçóes.

Instalação

npm

$ npm install culusms

PrimeirosPassos

Para criar uma instancia do culusms dentro de um arquivo .js(Obviamente) criado por ti. Adicione o seguinte trecho

const CuluSms = require('culusms');
//Acesse o teu painel no culusms.com navegue e copie a chave da api localizada em FERRAMENTAS -> CHAVES DE API
const client = new CuluSms("<Chave_da_API />") 

Mensagens

EnviarMensagem

Paramentros

"Destinatário" Number:<Obrigatório />, "Mensagem" String:<Obrigatório />, "Dispositivo" Number:<Opcional />
"SIM" Number:<Opcional />,  "Prioridade" (0 ou 1):<Opcional />

client.messages.send(000000000, 'Sent with culusms').then(res => {
  console.log('success',res)
}).catch(err => {
  console.log('error',err)
})

MensagensPendentes

Parametros

"Dispositivo" Number:<Opcional />

 client.messages.getPending().then(res => {
    console.log('pending', res)
}).catch(err => {
    console.log('error', err)
})

MensagensEnviadas

Parametros

 "Limite" Number:<Opcional /> ,"Página" Number:<Opcional />, "Dispositivo" Number:<Opcional />
 "Api" Boolean:<Opcional />, "Prioridade" Number:<Opcional />

client.messages.getSent(22, 0, 22, false, 1).then(res => {
    console.log('semt', res)
}).catch(err => {
    console.log('error', err)
})

MensagensRecebidas

Paramentros

 "Limite" Number:<Opcional /> ,"Página" Number:<Opcional />, "Dispositivo" Number:<Opcional />

client.messages.getReceived(5, 0, 22).then(res => {
  console.log('received', res)
}).catch(err => {
    console.log('error', err)
})

Dispositivos

ListarDispositivos

client.devices.getDevices().then(data => {
    console.log('success', data);
}).catch(err => {
    console.log('error', err)
})

ListarUmDispositivo

Paramentros

 "Id do dispositivo" Number:<Obrigatório />

client.devices.getDevice(1).then(data => {
    console.log('success', data);
}).catch(err => {
    console.log('error', err)
})

LivroDeEndereços

CriarGrupo

Paramentros

 "Nome do grupo" String:<Obrigatório />

client.addressBook.createGroup('Test').then(res => {
  console.log('success', res);
}).catch(err => {
    console.log('error', err)
})

ListarGrupos

client.addressBook.getGroups().then(res => {
    console.log('success', res);
}).catch(err => {
    console.log('error', err)
})

CriarContacto

Paramentros

"Número de telefone" Number:<Obrigatório />, "Nome" String:<Obrigatório />, "Id do grupo" Number:<Obrigatório />

client.addressBook.createContact('[phone]', 'Pietro Zim', 14).then(res => {
  console.log('success', res);
}).catch(err => {
    console.log('error', err)
})

ListarContactos

client.addressBook.getContacts().then(res => {
    console.log('success', res);
}).catch(err => {
    console.log('error', err)
})

EliminarGrupo

Paramentros

 "Id do grupo" Number:<Obrigatório />

client.addressBook.deleteGroup(15).then(res => {
  console.log('success', res);
}).catch(err => {
    console.log('error', err)
})

EliminarContacto

 "Id do contacto" Number:<Obrigatório />

client.addressBook.deleteContact(15).then(res => {
  console.log('success', res);
}).catch(err => {
    console.log('error', err)
})