/ 
SMS-Send-MessageBird-0.03
River stage zero No dependents
/ SMS::Send::MessageBird

NAME

SMS::Send::MessageBird - SMS::Send driver for the SMS::MessageBird distribution.

VERSION

Version 0.03

SYNOPSIS

Enables sending of SMS messages with the SMS::Send distribution using MessageBird's API as the providing gateway via the SMS::MessageBird distribution.

use SMS::Send;
use SMS::Send::MessageBird;

my $messagebird = SMS::Send->new(
    'SMS::Send::MessageBird',
    _api_key    => 'test_ABCDEF123456',
    _originator => 'James Ronan',
);
$messagebird->send_sms(
    text => 'Hi, How are you?',
    to   => '+441234567890',
);

DESCRIPTION

SMS::Send Driver for the SMS::MessageBird distribution - provides a simple interface for SMS sending via MessageBird.

This module isn't designed to be used on its own. Please see SMS::Send for more information.

METHODS

new (constructor)

send_sms

Sends an SMS via MessageBird.

As there are a whole host of optional parameters that can be passed to the MessageBird API, along with the required parameters, an additional '_parameters' key can be passed containing a hash of those options.

to

Required. This is mapped to SMS::MessageBird's recipients parameter. Due to the way SMS::Send works, it will accept only a single recipient.

text

Required. This is mapped to SMS::MessageBird's body parameter. It should contain the content of the message you wish to send.

_parameters

Optional. This should be a hashref of the extra parameters you wish to pass to SMS::MessageBird.

The one exception to the "optional" status is be the originator parameter, If you don't pass _originator to the SMS::Send constructor then you must provide it via the _parameters hashref.

AUTHOR

James Ronan, <james at ronanweb.co.uk>

BUGS

Please report any bugs or feature requests to bug-sms-send-messagebird at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=SMS-Send-MessageBird. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

Alternatively you can raise an issue on the source code which is available on GitHub.

LICENSE AND COPYRIGHT

Copyright 2016 James Ronan.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.