shoutoutlabs / shoutout-sdk
shoutout sdk for php
Installs: 1 602
Dependents: 1
Suggesters: 0
Security: 0
Stars: 1
Watchers: 1
Forks: 2
Open Issues: 0
Requires
- php: >=5.4
- ext-curl: *
- ext-json: *
- ext-mbstring: *
Requires (Dev)
- friendsofphp/php-cs-fixer: ~1.12
- phpunit/phpunit: ~4.8
- satooshi/php-coveralls: ~1.0
- squizlabs/php_codesniffer: ~2.6
This package is not auto-updated.
Last update: 2024-10-24 16:22:00 UTC
README
version: 2.1.0
Requirements
PHP 5.4.0 and later
Installation
You can install shoutout-sdk via composer or by downloading the source
Via Composer
shoutout-sdk is available on Packagist as the
shoutoutlabs/shoutout-sdk
package
composer require shoutoutlabs/shoutout-sdk
Getting Started
Please follow the installation Procedure and then run the following:
Send Message
<?php require __DIR__ . '/vendor/autoload.php'; use Swagger\Client\ShoutoutClient; $apiKey = 'XXXXXXXXX.XXXXXXXXX.XXXXXXXXX'; $client = new ShoutoutClient($apiKey,true,false); $message = array( 'source' => 'ShoutDEMO', 'destinations' => ['94777123456'], 'content' => array( 'sms' => 'Sent via SMS Gateway' ), 'transports' => ['SMS'] ); try { $result = $client->sendMessage($message); print_r($result); } catch (Exception $e) { echo 'Exception when sending message: ', $e->getMessage(), PHP_EOL; } ?>
Create Contacts
<?php require __DIR__ . '/vendor/autoload.php'; use Swagger\Client\ShoutoutClient; $apiKey = 'XXXXXXXXX.XXXXXXXXX.XXXXXXXXX'; $client = new ShoutoutClient($apiKey,true,false); $contact = array( 'mobile_number' => '94777123456',//Required if not specified user_id 'user_id' => '94777123456',//Optional. if specified, this will be used to generate the contact id, otherwise mobile_number will be used to generate contact id //arbitrary attributes 'email' => 'duke@test.com', 'tags' => ['lead'], 'name' => 'Duke' ); $contacts = array($contact); try { $result = $client->createContacts($contacts); print_r($result); } catch (Exception $e) { echo 'Exception when creating contacts ', $e->getMessage(), PHP_EOL; } ?>
Create Activity
<?php require __DIR__ . '/vendor/autoload.php'; use Swagger\Client\ShoutoutClient; $apiKey = 'XXXXXXXXX.XXXXXXXXX.XXXXXXXXX'; $client = new ShoutoutClient($apiKey,true,false); $activity = array( 'userId' => '94777123456',//Required. your account id //arbitrary attributes 'activityName' => 'Sample Activity', 'activityData' => array( 'param1' => 'val1', 'param2' => 'val2', 'param3' => 'val3' ) ); try { $result = $client->createActivity($activity); print_r($result); } catch (Exception $e) { echo 'Exception when creating activity ', $e->getMessage(), PHP_EOL; } ?>