NAME
Nexmo::SMS::TextMessage
VERSION
version 0.04
SYNOPSIS
This module simplifies sending SMS through the Nexmo API.
use Nexmo::SMS::TextMessage;
my $nexmo = Nexmo::SMS::TextMessage->new(
server => 'http://test.nexmo.com/sms/json',
username => 'testuser1',
password => 'testpasswd2',
text => 'This is a test',
from => 'Test02',
to => '452312432',
);
my $response = $sms->send || die $sms->errstr;
if ( $response->is_success ) {
print "SMS was sent...\n";
}NAME
Nexmo::SMS::TextMessage - Module that respresents a text message for the Nexmo SMS API!
VERSION
Version 0.01
METHODS
new
create a new object
my $message = Nexmo::SMS::TextMessage->new(
server => 'http://test.nexmo.com/sms/json',
username => 'testuser1',
password => 'testpasswd2',
);This method recognises these parameters:
text => 'required',
from => 'required',
to => 'required',
server => 'required',
username => 'required',
password => 'required',
status_report_req => 'optional',
client_ref => 'optional',
network_code => 'optional',user_agent
Getter/setter for the user_agent attribute of the object. By default a new object of LWP::UserAgent is used, but you can use your own class as long as it is compatible to LWP::UserAgent.
$sms->user_agent( MyUserAgent->new );
my $ua = $sms->user_agent;errstr
return the "last" error as string.
print $sms->errstr;send
This actually calls the Nexmo SMS API. It returns a Nexmo::SMS::Response object or undef (on failure).
my $sms = Nexmo::SMS::TextMessage->new( ... );
$sms->send or die $sms->errstr;check_needed_params
This method checks if all needed parameters are passed.
my $params_not_ok = Nexmo::SMS::TextMessage->check_needed_params( ... );
if ( $params_not_ok ) {
print "Please check $params_not_ok";
}Attributes
These attributes are available for Nexmo::SMS::TextMessage objects:
client_ref
from
network_code
password
server
status_report_req
text
to
username
ACKNOWLEDGEMENTS
COPYRIGHT & LICENSE
Copyright 2011 Renee Baecker.
This program is released under the following license: artistic_2
AUTHOR
Renee Baecker <module@renee-baecker.de>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2011 by Renee Baecker.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)