Skip to content

Latest commit

 

History

History
105 lines (81 loc) · 3.17 KB

driver-cisco-spark.md

File metadata and controls

105 lines (81 loc) · 3.17 KB
Raw

Cisco Spark

Installation & Setup

First you need to pull in the Cisco Spark Driver.

composer require botman/driver-cisco-spark

Then load the driver before creating the BotMan instance (only when you don't use BotMan Studio):

DriverManager::loadDriver(\BotMan\Drivers\CiscoSpark\CiscoSparkDriver::class);

// Create BotMan instance
BotManFactory::create($config);

Or if you use BotMan Studio:

php artisan botman:install-driver cisco-spark

This driver requires a valid and secure URL in order to set up webhooks and receive events and information from the chat users. This means your application should be accessible through an HTTPS URL.

{callout-info} ngrok is a great tool to create such a public HTTPS URL for your local application. If you use Laravel Valet, you can create it with "valet share" as well.

To connect BotMan with your Cisco Spark Bot, you first need to follow the official guide to create your Cisco Spark Bot and an access token.

Once you have obtained the access token and secret, place it in your BotMan configuration. If you use BotMan Studio, you can find the configuration file located under config/botman/cisco-spark.php.

If you dont use BotMan Studio, add these line to $config array that you pass when you create the object from BotManFactory.

'cisco-spark' => [
    'token' => 'YOUR-CISCO-SPARK-TOKEN-HERE',
    'secret' => 'YOUR-CISCO-SPARK-SECRET-HERE',
]

Supported Features

This is a list of features that the driver supports. If a driver does not support a specific action, it is in most cases a limitation from the messaging service - not BotMan.

Feature Supported?
Question-Buttons ❌
Image Attachment ✅
Video Attachment ✅
Audio Attachment ✅
Location Attachment ❌

Register Your Webhook

To let your Cisco Spark Bot know, how it can communicate with your BotMan bot, you have to register the URL where BotMan is running at, with Cisco Spark.

You can do this by sending a POST request to this URL:

curl -X POST -H "Accept: application/json" -H "Authorization: Bearer --YOUR-CISCO-SPARK-TOKEN--" -H "Content-Type: application/json" -d '{
    "name": "BotMan Webhook",
    "targetUrl": "--YOUR-URL--",
    "resource": "all",
    "event": "all"
}' "https://api.ciscospark.com/v1/webhooks"

Replace --YOUR-CISCO-SPARK-TOKEN-- with your access token. Replace --YOUR-URL-- with the URL that points to your BotMan logic / controller. If you use BotMan Studio it will be: https://yourapp.domain/botman.