Skip to content

whatsgate/js_sdk

Repository files navigation

api_whatsgateru

ApiWhatsgateru - JavaScript client for api_whatsgateru Интерфейс для взаимодействия с клиентом Whatsapp This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen For more information, please visit https://whatsgate.ru/

Installation

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install api_whatsgateru --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var ApiWhatsgateru = require('api_whatsgateru');
var defaultClient = ApiWhatsgateru.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token"

var api = new ApiWhatsgateru.DefaultApi()
var body = new ApiWhatsgateru.CheckBody(); // {CheckBody} Проверяет, зарегистрирован ли указанный номер в WhatsApp. Номер указывается в формате только цифр, например 79999999999

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkPost(body, callback);

Documentation for API Endpoints

All URIs are relative to https://whatsgate.ru/v1

Class Method HTTP request Description
ApiWhatsgateru.DefaultApi checkPost POST /check Проверка зарегистрирован ли номер в WhatsApp
ApiWhatsgateru.DefaultApi getChatsPost POST /get-chats Возвращает список активных чатов
ApiWhatsgateru.DefaultApi seenPost POST /seen Отправляет команду в чат, что последние сообщения просмотрены
ApiWhatsgateru.DefaultApi sendMessage POST /send Отправка сообщения
ApiWhatsgateru._Api getMediaPost POST /get-media Возвращает объект медиафайла, прикрепленного к сообщению

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

About

ApiWhatsgateru - JavaScript client for api_whatsgateru

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published