1
0
mirror of synced 2024-11-22 04:26:02 +03:00
mg-bot-api-client-js/README.md

54 lines
1.1 KiB
Markdown
Raw Normal View History

2018-09-04 10:26:32 +03:00
# retailCRM Message Gateway Bot API JS client
2019-02-06 14:54:15 +03:00
This is js retailCRM bot API client. [API documentation](https://139810.selcdn.ru/download/doc/mg-bot-api/bot.v1.html)
# Installation
```
npm install --save mg-bot-api-client-js
```
In your file
```
2019-02-06 14:55:26 +03:00
var RetailcrmBotApiClient = require('mg-bot-api-client-js');
2019-02-06 14:54:15 +03:00
```
# Usage
#### Get users
```javascript
var api = new RetailcrmBotApiClient({
host: 'https://api.example.com',
token: 'your bot token',
apiVersion: 'v1' // optional
2019-02-08 13:31:38 +03:00
}).getClient();
2019-02-06 14:54:15 +03:00
api.getUsers()
.then(function (users) {
console.log(users);
})
.catch(function (e) {
console.log(e);
});
```
#### Send message
```javascript
var api = new RetailcrmBotApiClient({
host: 'https://api.example.com',
token: 'your bot token',
apiVersion: 'v1' // optional
2019-02-08 13:31:38 +03:00
}).getClient();
2019-02-06 14:54:15 +03:00
var message = {
chat_id: 1,
content: 'Text message',
scope: 'public',
type: 'text'
2019-02-08 13:31:38 +03:00
};
2019-02-06 14:54:15 +03:00
api.sendMessage(message)
.then(function (result) {
console.log(result);
})
.catch(function (e) {
console.log(e);
});
```