Verify Passphrase Component

SkyCrate Ltd. - Graham Robertson

Verify Passphrase is used to aid in the verification of a user's identity by testing their knowledge of a previously stored passphrase. The user is asked to identity three letters contained in the passphrase.

Supported Languages

• English (en-gb,en-ca,en-us)

Bot Component Endpoints

RESTful over HTTPS://

Simple request/response endpoint. The session_id is to be generated by the client.

https://skycrate.net/exchange/skycrate-verify-passphrase

https://skycrate.net/exchange/skycrate-verify-passphrase/<session_id>

Secure Web Socket

Asynchronous endpoint for easier distribution of messages to multiple clients (perhaps in group conversions).

wss://skycrate.net/exchange/skycrate-verify-passphrase/<session_id>

IPC (Internal Use Only)

Endpoint of the component's parallel process in the server environment.

ipc://@skycrate-verify-passphrase

Bot Component Endpoint API

POST Request / Web Socket Message

Exchange Body

Data to be sent with each POST request or Web Socket message.

Session Context

Auxillary information used by the bot to determine appropriate responses. Usually only needs to be sent on the first request.

Exchange Response

The bot component response to your exchange request.

Updated Context

Any updated or new data from the bot.

Custom Responses

Using a PUT request at either https://skycrate.net/exchange/skycrate-verify-passphrase:<instance_id> or https://skycrate.net/exchange/skycrate-verify-passphrase/<session_id>, you can save your custom responses to the instance or the session and the component will use these responses instead.

const request = require('request');
request({
  url: "https://skycrate.net/exchange/\
    skycrate-verify-passphrase/xawy8xtl4whc",
  method: 'PUT',
  json: {
    "index": [
      "Hello, World.",
      ⋮
      "Good [time_of_day], human."
    ],
    ⋮
    "exit": [
      "Goodbye, World.",
      ⋮
      "Have a pleasant [time_of_day], human."
    ]
  },
}, (e, r, b) => {
  if (e) {
    return; // Do some error stuff
  }
  console.log('Responses saved.');
});

Like in the example above, send a dictionary whose keys are the names of the actions you wish to customise. Their corresponding value is an array of possible text responses.

Bot Actions

Response Template Values

Values that you can use when customising the bot's responses.