362 lines
10 KiB
PHP
362 lines
10 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of RaspiSMS.
|
|
*
|
|
* (c) Pierre-Lin Bonnemaison <plebwebsas@gmail.com>
|
|
*
|
|
* This source file is subject to the GPL-3.0 license that is bundled
|
|
* with this source code in the file LICENSE.
|
|
*/
|
|
|
|
namespace adapters;
|
|
|
|
use Twilio\Rest\Client;
|
|
|
|
/**
|
|
* Twilio SMS service with a virtual number adapter.
|
|
*/
|
|
class TwilioVirtualNumberAdapter implements AdapterInterface
|
|
{
|
|
/**
|
|
* Datas used to configure interaction with the implemented service. (e.g : Api credentials, ports numbers, etc.).
|
|
*/
|
|
private $datas;
|
|
|
|
/**
|
|
* Twilio Api client.
|
|
*/
|
|
private $client;
|
|
|
|
/**
|
|
* Twilio virtual number to use.
|
|
*/
|
|
private $number;
|
|
|
|
/**
|
|
* Callback address Twilio must call on SMS status change.
|
|
*/
|
|
private $status_change_callback;
|
|
|
|
/**
|
|
* Adapter constructor, called when instanciated by RaspiSMS.
|
|
*
|
|
* @param string $number : Phone number the adapter is used for
|
|
* @param json string $datas : JSON string of the datas to configure interaction with the implemented service
|
|
*/
|
|
public function __construct(string $datas)
|
|
{
|
|
$this->datas = json_decode($datas, true);
|
|
|
|
$this->client = new Client(
|
|
$this->datas['account_sid'],
|
|
$this->datas['auth_token']
|
|
);
|
|
|
|
$this->number = $this->datas['number'];
|
|
$this->status_change_callback = $this->datas['status_change_callback'];
|
|
}
|
|
|
|
/**
|
|
* Classname of the adapter.
|
|
*/
|
|
public static function meta_classname(): string
|
|
{
|
|
return __CLASS__;
|
|
}
|
|
|
|
/**
|
|
* Uniq name of the adapter
|
|
* It should be the classname of the adapter un snakecase.
|
|
*/
|
|
public static function meta_uid(): string
|
|
{
|
|
return 'twilio_virtual_number_adapter';
|
|
}
|
|
|
|
/**
|
|
* Name of the adapter.
|
|
* It should probably be the name of the service it adapt (e.g : Gammu SMSD, OVH SMS, SIM800L, etc.).
|
|
*/
|
|
public static function meta_name(): string
|
|
{
|
|
return 'Twilio Numéro virtuel';
|
|
}
|
|
|
|
/**
|
|
* Description of the adapter.
|
|
* A short description of the service the adapter implements.
|
|
*/
|
|
public static function meta_description(): string
|
|
{
|
|
$credentials_url = 'https://www.twilio.com/console';
|
|
|
|
return '
|
|
Solution de SMS avec numéro virtuel proposé par <a target="_blank" href="https://www.twilio.com/sms">Twilio</a>. Pour trouver vos clés API Twilio <a target="_blank" href="' . $credentials_url . '">cliquez ici.</a><br/>
|
|
Pour plus d\'information sur l\'utilisation de l\'adaptateur, reportez-vous à <a href="https://documentation.raspisms.fr/users/adapters/twilio_virtual_number.html" target="_blank">la documentation sur l\'adaptateur Twilio Numéro Virtuel.</a>
|
|
';
|
|
}
|
|
|
|
/**
|
|
* List of entries we want in datas for the adapter.
|
|
*
|
|
* @return array : Every line is a field as an array with keys : name, title, description, required
|
|
*/
|
|
public static function meta_datas_fields(): array
|
|
{
|
|
return [
|
|
[
|
|
'name' => 'account_sid',
|
|
'title' => 'Account SID',
|
|
'description' => 'Identifiant unique Twilio, trouvable sur la page d\'accueil de la console Twilio.',
|
|
'required' => true,
|
|
],
|
|
[
|
|
'name' => 'auth_token',
|
|
'title' => 'Auth Token',
|
|
'description' => 'Jeton d\'identification Twilio, trouvable sous le Account SID.',
|
|
'required' => true,
|
|
],
|
|
[
|
|
'name' => 'number',
|
|
'title' => 'Numéro de téléphone virtuel',
|
|
'description' => 'Numéro de téléphone virtuel Twilio à utiliser parmis les numéro actifs (format international), <a href="https://www.twilio.com/console/phone-numbers/incoming" target="_blank">voir la liste ici</a>.',
|
|
'required' => true,
|
|
'number' => true,
|
|
],
|
|
[
|
|
'name' => 'status_change_callback',
|
|
'title' => 'Callback de changement de status',
|
|
'description' => 'L\'adresse que Twilio devra appeler pour signaler le changement de statut d\'un SMS. Laissez tel quel par défaut.',
|
|
'required' => true,
|
|
'default_value' => \descartes\Router::url('Callback', 'update_sended_status', ['adapter_uid' => self::meta_uid()], ['api_key' => $_SESSION['user']['api_key'] ?? '<your_api_key>']),
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Does the implemented service support reading smss.
|
|
*/
|
|
public static function meta_support_read(): bool
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Does the implemented service support flash smss.
|
|
*/
|
|
public static function meta_support_flash(): bool
|
|
{
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Does the implemented service support status change.
|
|
*/
|
|
public static function meta_support_status_change(): bool
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Does the implemented service support reception callback.
|
|
*/
|
|
public static function meta_support_reception(): bool
|
|
{
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Method called to send a SMS to a number.
|
|
*
|
|
* @param string $destination : Phone number to send the sms to
|
|
* @param string $text : Text of the SMS to send
|
|
* @param bool $flash : Is the SMS a Flash SMS
|
|
*
|
|
* @return array : [
|
|
* bool 'error' => false if no error, true else
|
|
* ?string 'error_message' => null if no error, else error message
|
|
* array 'uid' => Uid of the sms created on success
|
|
* ]
|
|
*/
|
|
public function send(string $destination, string $text, bool $flash = false)
|
|
{
|
|
$response = [
|
|
'error' => false,
|
|
'error_message' => null,
|
|
'uid' => null,
|
|
];
|
|
|
|
try
|
|
{
|
|
$message = $this->client->messages->create(
|
|
$destination,
|
|
[
|
|
'from' => $this->number,
|
|
'body' => $text,
|
|
'statusCallback' => $this->status_change_callback,
|
|
]
|
|
);
|
|
|
|
if (null !== $message->errorCode)
|
|
{
|
|
$response['error'] = true;
|
|
$response['error_message'] = $message->errorMessage;
|
|
|
|
return $response;
|
|
}
|
|
|
|
$response['uid'] = $message->sid;
|
|
|
|
return $response;
|
|
}
|
|
catch (\Throwable $t)
|
|
{
|
|
$response['error'] = true;
|
|
$response['error_message'] = $t->getMessage();
|
|
|
|
return $response;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Method called to read SMSs of the number.
|
|
*
|
|
* @return array : [
|
|
* bool 'error' => false if no error, true else
|
|
* ?string 'error_message' => null if no error, else error message
|
|
* array 'sms' => Array of the sms reads
|
|
* ]
|
|
*/
|
|
public function read(): array
|
|
{
|
|
$response = [
|
|
'error' => false,
|
|
'error_message' => null,
|
|
'smss' => [],
|
|
];
|
|
|
|
try
|
|
{
|
|
$messages = $this->client->messages->read([
|
|
'to' => $this->number,
|
|
], 20);
|
|
|
|
foreach ($messages as $record)
|
|
{
|
|
if ('inbound' !== $record->direction)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
$timezone = date_default_timezone_get();
|
|
$record->dateCreated->setTimezone(new \DateTimeZone($timezone));
|
|
|
|
$response['smss'][] = [
|
|
'at' => $record->dateCreated->format('Y-m-d H:i:s'),
|
|
'text' => $record->body,
|
|
'origin' => $record->from,
|
|
];
|
|
|
|
//Remove sms to prevent double reading
|
|
$this->client->messages($record->sid)->delete();
|
|
}
|
|
|
|
return $response;
|
|
}
|
|
catch (\Throwable $t)
|
|
{
|
|
$response['error'] = true;
|
|
$response['error_message'] = $t->getMessage();
|
|
|
|
return $response;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Method called to verify if the adapter is working correctly
|
|
* should be use for exemple to verify that credentials and number are both valid.
|
|
*
|
|
* @return bool : False on error, true else
|
|
*/
|
|
public function test(): bool
|
|
{
|
|
try
|
|
{
|
|
$phone_numbers = $this->client->incomingPhoneNumbers->read(['phoneNumber' => $this->number], 20);
|
|
|
|
foreach ($phone_numbers as $record)
|
|
{
|
|
//If not the same number, return false
|
|
if ($record->phoneNumber !== $this->number)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
return true; //Same number, its all ok we can return true
|
|
}
|
|
|
|
return false;
|
|
}
|
|
catch (\Throwable $t)
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Method called on reception of a status update notification for a SMS.
|
|
*
|
|
* @return mixed : False on error, else array ['uid' => uid of the sms, 'status' => New status of the sms (\models\Sended::STATUS_UNKNOWN, \models\Sended::STATUS_DELIVERED, \models\Sended::STATUS_FAILED)]
|
|
*/
|
|
public static function status_change_callback()
|
|
{
|
|
$sid = $_REQUEST['MessageSid'] ?? false;
|
|
$status = $_REQUEST['MessageStatus'] ?? false;
|
|
|
|
if (!$sid || !$status)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
switch ($status)
|
|
{
|
|
case 'delivered':
|
|
$status = \models\Sended::STATUS_DELIVERED;
|
|
|
|
break;
|
|
|
|
case 'failed':
|
|
$status = \models\Sended::STATUS_FAILED;
|
|
|
|
break;
|
|
|
|
default:
|
|
$status = \models\Sended::STATUS_UNKNOWN;
|
|
|
|
break;
|
|
}
|
|
|
|
return ['uid' => $sid, 'status' => $status];
|
|
}
|
|
|
|
/**
|
|
* Method called on reception of a sms notification.
|
|
*
|
|
* @return array : [
|
|
* bool 'error' => false on success, true on error
|
|
* ?string 'error_message' => null on success, error message else
|
|
* array 'sms' => array [
|
|
* string 'at' : Recepetion date format Y-m-d H:i:s,
|
|
* string 'text' : SMS body,
|
|
* string 'origin' : SMS sender,
|
|
* ]
|
|
*
|
|
* ]
|
|
*/
|
|
public static function reception_callback(): array
|
|
{
|
|
return [];
|
|
}
|
|
}
|