repat/respond-io-client

Client for respond.io contacts and messaging API

dev-main 2022-08-30 10:35 UTC

Requires

• php: ^8.0 | ^8.1
• guzzlehttp/guzzle: ^6.0 | ^7.0

MIT

• repat

• api
• client
• sdk
• contacts
• messages
• respond.io
• respondio

README

⚠️ WORK IN PROGRESS ⚠️

respond-io-client is the unofficial package for the respond.io messaging platform API. Pull requests welcome.

Installation

composer require repat/respond-io-client

Usage

The library will generally throw Guzzle's Exceptions, see Contacts API Error Codes and Messages API Error Codes in their documentation.

Setup

$apiToken = '...'; // Get an API token from the website, one per channel
$options = []; // Guzzle Options - should probably be left empty, but just in case.
// ...
$client = new \Repat\RespondIoClient\Client($apiToken, $options);

Contacts

Please note that in case of Viber Channel - due to a certain limitation - the Contact ID needs to be provided in a Base64 encoded format.

// Get ID
$id = '...';

/*
|--------------------------------------------------------------------------
| Get Contacts
|--------------------------------------------------------------------------
*/
// If you know the ID
$client->getContactById($id);

// Search by field
$customFieldName = 'phone';
$customFieldValue = '[phone]';
$client->getContactByCustomField($customFieldName, $customFieldValue);

/*
|--------------------------------------------------------------------------
| Update Contacts
|--------------------------------------------------------------------------
*/
$fields = [
	'phone' => '[phone]',
];

$client->updateContact($id, $fields);

/*
|--------------------------------------------------------------------------
| Tags
|--------------------------------------------------------------------------
*/

$tags = ['foo', 'bar'];

$client->addTag($id, $tags);
$client->removeTag($id, $tags);

/*
|--------------------------------------------------------------------------
| Create Contact
|--------------------------------------------------------------------------
*/
$fields = [
	'firstName' => 'John',
	'lastName' => 'Doe',
	'phone' => '[phone]',
	'email' => '[e-mail]'
	//
];

$client->createContact($fields);

Messages

/*
|--------------------------------------------------------------------------
| Text
|--------------------------------------------------------------------------
*/

$client->sendText($id, $text);

/*
|--------------------------------------------------------------------------
| Attachments
|--------------------------------------------------------------------------
*/
$type = Client::TYPE_IMAGE; // 'image'

// OR:
// $type = Client::TYPE_AUDIO; // 'audio'
// $type = Client::TYPE_VIDEO; // 'video'
// $type = Client::TYPE_FILE; // 'file

$url = 'https://repat.de/Bilder/repat40x40.png';

$client->sendAttachment($id, $type, $url);

/*
|--------------------------------------------------------------------------
| Quick Reply
|--------------------------------------------------------------------------
*/

$title = 'Would you like Foo, Bar or Baz?';
$replies = ['Foo', 'Bar', 'Baz'];

$client->sendQuickReply($id, $title, $replies);

ToDo

• Composer / Packagist release
• Tests
• Message Template API

License

• MIT

Version

• Version 0.1

Contact

repat

• Homepage: repat.de
• e-mail: [e-mail]
• Twitter: @repat123
• other communication/social media