Skip to content
This repository has been archived by the owner on Feb 8, 2020. It is now read-only.

Latest commit

 

History

History

broid-skype

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

npm node deps tests bithound bithoundscore nsp-checked

Broid Skype 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 slackin

Message types supported

Simple Image Video Buttons Location Phone number

Location, Phone number are platform limitations.

Getting started

Install

npm install --save @broid/skype

Connect to Skype

const BroidSkype = require('@broid/skype');

const skype = new BroidSkype({
  token: 'xxxxx',
  tokenSecret: 'xxxxxx',
  http: {
    host: '127.0.0.1',
    port: 8080
  }
});

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

Skype can also be used with your existing express setup.

const BroidSkype = require('broid-skype');
const express = require("express");

const skype  = new BroidSkype({
  token: 'xxxxx',
  tokenSecret: 'xxxxxx',
});

const app = express();
app.use("/skype", skype.getRouter());

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

app.listen(8080);

Options available

name Type default Description
token string
token_secret string
service_id string random Arbitrary identifier of the running instance
log_level string debug Can be : fatal, error, warn, info, debug, trace
http object HTTP options (host, port)

Receive a message

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

Buttons supported

mediaType Action types Content of value property
text/html open-url URL to be opened in the built-in browser.
audio/telephone-event call Destination for a call in following format: "tel:123123123123".
imBack Text of message which client will sent back as ordinary chat message.

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": "skype"
  },
  "object": {
    "type": "Note",
    "content": "hello world",
    "context": {
      "type": "Object",
      "name": "address_id",
      "content": "xxxxxxx#29:xxxxxxxxxxxx#skype#28:xxxxxxxxxxxx"
    }
  },
  "to": {
    "type": "Person",
    "id": "2932680234"
  }
};

skype.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.