th3-chatengine-sdk

v1.0.3

Published

4 years ago

th3 chat sdk

0High
0Medium
0Low

chat_api_sdk

ChatApiSdk - JavaScript client for chat_api_sdk The SDK allows you to receive and send messages through your WhatsApp account. Sign up now The Chat API is based on the WhatsApp WEB protocol and excludes the ban both when using libraries from mgp25 and the like. Despite this, your account can be banned by anti-spam system WhatsApp after several clicking the "block" button. This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

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

Then install it via:

npm install th3-chat-sdk--save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your th3-chat-sdkfrom, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

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

    npm install YOUR_USERNAME/th3-chat-sdk--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 ChatApiSdk = require('chat_api_sdk');

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

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

Documentation for API Endpoints

All URIs are relative to https://api.chat-api.com

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ChatApiSdk.Class1InstanceApi | expiry | POST /expiry | Updates the QR code after its expired ChatApiSdk.Class1InstanceApi | getQRCode | GET /qr_code | Direct link to QR-code in the form of an image, not base64. ChatApiSdk.Class1InstanceApi | getSettings | GET /settings | Get settings ChatApiSdk.Class1InstanceApi | getStatus | GET /status | Get the account status and QR code for authorization. ChatApiSdk.Class1InstanceApi | logout | POST /logout | Logout from WhatsApp Web to get new QR code. ChatApiSdk.Class1InstanceApi | reboot | POST /reboot | Reboot your whatsapp instance. ChatApiSdk.Class1InstanceApi | retry | POST /retry | Repeat the manual synchronization attempt with the device ChatApiSdk.Class1InstanceApi | setSettings | POST /settings | Set settings ChatApiSdk.Class1InstanceApi | takeover | POST /takeover | Returns the active session if the device has connected another instance of Web WhatsApp ChatApiSdk.Class2MessagesApi | forwardMessage | POST /forwardMessage | Forwarding messages to a new or existing chat. ChatApiSdk.Class2MessagesApi | getMessages | GET /messages | Get a list of messages. ChatApiSdk.Class2MessagesApi | sendContact | POST /sendContact | Sending a contact or contact list to a new or existing chat. ChatApiSdk.Class2MessagesApi | sendFile | POST /sendFile | Send a file to a new or existing chat. ChatApiSdk.Class2MessagesApi | sendLink | POST /sendLink | Send text with link and link's preview to a new or existing chat. ChatApiSdk.Class2MessagesApi | sendLocation | POST /sendLocation | Sending a location to a new or existing chat. ChatApiSdk.Class2MessagesApi | sendMessage | POST /sendMessage | Send a message to a new or existing chat. ChatApiSdk.Class2MessagesApi | sendPTT | POST /sendPTT | Send a ptt-audio to a new or existing chat. ChatApiSdk.Class2MessagesApi | sendVCard | POST /sendVCard | Sending a vcard to a new or existing chat. ChatApiSdk.Class3ChatsApi | addGroupParticipant | POST /addGroupParticipant | Adding participant to a group ChatApiSdk.Class3ChatsApi | demoteGroupParticipant | POST /demoteGroupParticipant | Demote group participant ChatApiSdk.Class3ChatsApi | getChats | GET /dialogs | Get the chat list. ChatApiSdk.Class3ChatsApi | group | POST /group | Creates a group and sends the message to the created group. ChatApiSdk.Class3ChatsApi | promoteGroupParticipant | POST /promoteGroupParticipant | Make participant in the group an administrator ChatApiSdk.Class3ChatsApi | readChat | POST /readChat | Open chat for reading messages ChatApiSdk.Class3ChatsApi | removeGroupParticipant | POST /removeGroupParticipant | Remove participant from a group ChatApiSdk.Class4WebhooksApi | setWebhook | POST /webhook | Sets the URL for receiving webhook ChatApiSdk.Class5QueuesApi | clearActionsQueue | POST /clearActionsQueue | Clear outbound actions queue. ChatApiSdk.Class5QueuesApi | clearMessagesQueue | POST /clearMessagesQueue | Clear outbound messages queue. ChatApiSdk.Class5QueuesApi | showActionsQueue | GET /showActionsQueue | Get outbound messages queue. ChatApiSdk.Class5QueuesApi | showMessagesQueue | GET /showMessagesQueue | Get outbound messages queue. ChatApiSdk.Class6BanApi | banTest | POST /banTest | Test ban settings ChatApiSdk.Class6BanApi | getBanSettings | GET /banSettings | Get settings ChatApiSdk.Class6BanApi | setBanSettings | POST /banSettings | Set settings ChatApiSdk.Class7TestingApi | instanceStatuses | GET /instanceStatuses | Returns instance status changes history. ChatApiSdk.Class7TestingApi | webhookStatuses | GET /webhookStatus | Returns webhook status for message.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

chat_api_sdk

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

instanceId

token