Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@broid/kik

2.2.0 • Public • Published

npm node deps tests bithound bithoundscore nsp-checked

Broid Kik Integration

Broid Integrations is an open source project providing a suite of Activity Streams 2 libraries for unified communications among a vast number of communication platforms.

Connect your App to Multiple Messaging Channels with One OpenSource Language.

gitter

Message types supported

Simple Image Video Buttons Location Phone number

Buttons, Location, Phone number are platform limitations.

Getting started

Install

npm install --save @broid/kik

Connect to Kik

const BroidKik = require('@broid/kik');
 
const kik = new broidKik({
  username: "<not_name>",
  token: "<api_key>",
  webhookURL: "http://example.com/"
  http: {
    host: "0.0.0.0",
    port: 8080
  }
});
 
kik.connect()
  .subscribe({
    next: data => console.log(data),
    error: err => console.error(`Something went wrong: ${err.message}`),
    complete: () => console.log('complete'),
  });

Kik can also be used with your existing express setup.

const BroidKik = require('@broid/kik');
const express = require("express");
 
const kik = new broidKik({
  username: "<not_name>",
  token: "<api_key>",
  webhookURL: "http://example.com/"
});
 
kik.connect()
  .subscribe({
    next: data => console.log(data),
    error: err => console.error(`Something went wrong: ${err.message}`),
    complete: () => console.log('complete'),
  });
 
const app = express();
app.use("/kik", kik.getRouter());
app.listen(8080);

When using the kik integration in an express application, ensure that you do not mount any kind of body-parser middleware before the router. The official kik library expects to handle a raw body itself.

Options available

name Type default Description
serviceID string random Arbitrary identifier of the running instance
logLevel string info Can be : fatal, error, warn, info, debug, trace
token string Your API Key
username string Your bot name
http object { "port": 8080, "http": "0.0.0.0", "webhookURL": "127.0.0.1" } WebServer options (host, port, webhookURL)

Note: webhookURL need to contain a path because Kik incomingPath not support empty value.

Buttons supported

Kik support simple quick reply button

Receive a message

kik.listen()
  .subscribe({
    next: data => console.log(`Received message: ${data}`),
    error: err => console.error(`Something went wrong: ${err.message}`),
    complete: () => console.log('complete'),
  });

Post a message

To send a message, the format should use the broid-schemas.

const formatted_message = {
  "@context": "https://www.w3.org/ns/activitystreams",
  "type": "Create",
  "generator": {
    "id": "f6e92eb6-f69e-4eae-8158-06613461cf3a",
    "type": "Service",
    "name": "kik"
  },
  "object": {
    "type": "Note",
    "content": "hello world"
  },
  "to": {
    "type": "Person",
    "id": "sally2"
  }
};
 
kik.send(formatted_message)
  .then(() => console.log("ok"))
  .catch(err => console.error(err));

Examples of messages

You can find examples of sent and received messages at Broid-Schemas.

Contributing to Broid

See CONTRIBUTE.md

Copyright & License

Copyright (c) 2016-2017 Broid.ai

This project is licensed under the AGPL 3, which can be found here.

Install

npm i @broid/kik

DownloadsWeekly Downloads

6

Version

2.2.0

License

AGPL-3.0+

Last publish

Collaborators

  • avatar
  • avatar
  • avatar