# aircall

> Aircall API for node

Latest version **0.1.0** (published 2018-09-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install aircall
pnpm add aircall
yarn add aircall
bun add aircall
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2018-09-28 |
| First published | 2015-12-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 16 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Franco Bouly |
| Maintainers | rayfranco |
| Keywords | aircall, API |

## Links

- npm: https://www.npmjs.com/package/aircall
- Repository: https://github.com/rayfranco/aircall
- Homepage: https://github.com/rayfranco/aircall#readme
- Issues: https://github.com/rayfranco/aircall/issues
- npm.io page: https://npm.io/package/aircall

## Dependencies (2)

- [defaults](https://npm.io/package/defaults.md) ~1.0.3
- [superagent](https://npm.io/package/superagent.md) ^3.8.3

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2018-09-28
- 0.0.2 — 2016-01-01
- 0.0.1 — 2015-12-31

## README

# Aircall

[![Build Status](https://travis-ci.org/rayfranco/aircall.svg?branch=master)](https://travis-ci.org/rayfranco/aircall)

An [Aircall](https://developer.aircall.io/api-references/) API for node.

## Installation

```bash
$ npm install aircall
```

## Example

Create an Aircall instance

```javascript
var aircall = require('aircall')(apiID, apiToken)
```

Get company informations

```javascript
aircall.company(function(err, res){
  console.log(res)
})
```

List contacts

```javascript
aircall.contacts.list(function(err, res){
  console.log(res.contacts)
})
```

List last phone calls by desc order

```javascript
aircall.calls.list(function(err, res){
  console.log(res)
}, {
  order: 'desc'
})
```

Get specific user

```javascript
aircall.users.get(12345, function(err, res){
  console.log(res.user)
})
```

## Tests

- Add `AIRCALL_ID` and `AIRCALL_TOKEN` environment variables corresponding to your account.
- Make sure you have at least one `Call` and one `User` in your account before running the tests.
- Be aware that the tests will create a dummy Contact _(John or Jane Doe)_ in your account. If anything goes wrong in the Contact block, you may have to manually delete this contact.

This is how you run the tests:

```bash
$ npm test
```

---
_Source: https://npm.io/package/aircall · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._