/ 
SMS-Send-UK-123txt-0.0.3
River stage zero No dependents
/ SMS::Send::UK::123txt

NAME

SMS::Send::UK::123txt

VERSION

Version 0.0.3

SYNOPSIS

# Instantiate a sender object
my $sender = SMS::Send->new(
    'UK::123txt',
    _login    => 'username',
    _password => 'password',
    _from     => 'source_number',
);

# Send a message
my $sent = $sender->send_sms(
    text => 'This is my message',
    to   => '0000000000' # In the format: 447312345679
);

DESCRIPTION

SMS::Send::UK::123txt is a SMS::Send driver that provides SMS message sending via the 123-txt service

CAVEATS

You need a 123-txt account in order to use this driver

METHODS

new

# Instantiate a sender object
my $sender = SMS::Send->new(
    'UK::123txt',
    _login    => 'username',
    _password => 'password',
    _from     => 'source_number',
);

The new constructor accepts three parameters, all of which are required:

The return value is a SMS::Send::UK::123txt object.

'UK::123txt'

The parameter identifying the driver name

_login

The _login parameter as supplied by 123-txt

_password

The _password parameter as supplied by 123-txt

_from

The _from parameter as specified in your 123-txt account as a source number or source id

clean_to

# Examine a passed phone number and attempt to return the number
# in a format supported by the API,
# croak if a conversion is not possible
my $intl_number = clean_to($source_number);

The clean_to method accepts a single required parameter:

The return value is the number in international format

source_number

A string containing the number to be cleaned

send_sms

# Send a message
my $sent = $sender->send_sms(
    text => 'This is my message',
    to   => '0000000000' # In the format: 447312345679
);

The send_sms method accepts two parameters, both of which are required:

The return value is a 0 or 1 representing false or true, indicating whether the send was successful.

text

A string of text representing the message, limited to 160 characters

to

A numeric string representing the phone number of the recipient, in a valid international format (i.e. country code followed by the number)

AUTHOR

Andrew Isherwood <andrew.isherwood at ptfs-europe.com>

BUGS

Please report any bugs or features to andrew.isherwood at ptfs-europe.com

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc SMS::Send::UK::123txt

COPYRIGHT & LICENSE

Copyright (C) 2018 PTFS Europe https://www.ptfs-europe.com/

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

Additionally, you are again reminded that this software comes with no warranty of any kind, including but not limited to the implied warranty of merchantability.

ANY use may result in charges on your 123-txt bill, and you should use this software with care. The author takes no responsibility for any such charges accrued.

ACKNOWLEDGEMENTS

Many thanks to the authors of the following modules that served as inspiration for this one:

SMS::Send::US::TMobile
SMS::Send::US::Ipipi
SMS::Send::UK::Kapow