Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
altiria authored Jan 10, 2022
1 parent b4dd9dd commit 486bf7d
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Altiria, cliente NodeJs js

![](https://img.shields.io/badge/version-1.0.1-blue.svg)
![](https://img.shields.io/badge/version-1.0.2-blue.svg)

Altiria SMS NodeJs es un cliente que simplifica al máximo la integración de nuestro API para NodeJs. Por el momento, esta librería abarca las funciones más básicas:
- **Envíos de SMS individuales** con las siguientes características:
Expand All @@ -16,8 +16,8 @@ Altiria SMS NodeJs es un cliente que simplifica al máximo la integración de nu

## Requisitos

- NodeJS: 9.4+
- NPM: 5.6.0+
- NodeJS: v14.18.1+
- NPM: 8.3.0+

## Instalación

Expand All @@ -34,6 +34,22 @@ npm install sms-altiria-client --save

A continuación se describen cada una de las posibilidades de uso de la librería para realizar envíos de SMS.

#### Ejemplo simplificado

Se muestra el código indispensable para realizar un envío básico. No se gestionan las excepciones.

```js
const AltiriaClient = require('sms-altiria-client/src/altiria-client');
const AltiriaModelTextMessage = require('sms-altiria-client/src/altiria-model-text-message');

let altiriaClient = new AltiriaClient('miusuario@email.com', 'contraseña');
let textMessage = new AltiriaModelTextMessage('346XXXXXXXX', 'Mensaje de prueba');
(async () => {
const data = await altiriaClient.sendSms(textMessage);
console.log('Mensaje enviado: ',await data);
})();
```

#### Ejemplo básico

Se trata de la opción más sencilla para realizar un envío de SMS.
Expand Down

0 comments on commit 486bf7d

Please sign in to comment.