The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
SMS-API-QuickTelecom-0.04
River stage zero No dependents
/ SMS::API::QuickTelecom

NAME

SMS::API::QuickTelecom - QuickTelecom SMS service on qtelecom.ru

VERSION

Version 0.04

SYNOPSIS

    use SMS::API::QuickTelecom;

    my $qtsms = SMS::API::QuickTelecom->new(
        user => 'account-login',
        pass => 'account-password',
    );

    $qtsms->send_sms(message=>'Test-SMS', target=>'+799912345678');

    print "Balance-XML:\n".$qtsms->balance();

Overview

A quick perl port of few classes from official PHP QTSMS.class for SMS sending.

Default settings are set to use HTTPS for communication.

METHODS

SMS::API::QuickTelecom->new(%options)

Instantiate and initialise object with the following options:

user => $account_name

Account username you receive during your registration. Mandatory.

pass => $password

Account password you receive during your registration. Mandatory.

host => $hostname // 'go.qtelecom.ru'

Optional.

Host name to perform POST/GET requests to. When using SSL (by default) it's default to go.qtelecom.ru.

If you are willing to use insecure communication via plain HTTP then host must be set to service.qtelecom.ru and ssl=0.

path => $path // '/public/http'

Optional.

Path on server to perform requests. Default is /public/http.

ssl => $ssl // '1'

Optional.

Flag to use SSL, default is 1 (on). Optional.

gzip => $gzip // 'none'

Optional.

Flag to enable|disable gzip-encoding of data, possible values are: none or on, default is none.

Optional

comment => $comment // ''

Optional.

Connection description.

HTTP_ACCEPT_LANGUAGE => $lang // 'en'

Optional.

Langage to use for the returned data content.

CLIENTADR => $ip // '127.0.0.1'

Optional.

IP-address of the sender. If not specified will be set to 127.0.0.1 internally.

sender => $sender // default

Optional.

Name of the sender, registered in system on https://go.qtelecom.ru.

If not specified default setting from system will be used.

balance

Returns an XML describing account balance and overdraft in the national currency.

Takes no parameters.

send_sms

Sends a text SMS to one or more recipients.

Return XML with report.

message => $message

Mandatory.

Message text to send. Enconding must be ASCII or UTF-8. Internally module is using UTF-8 encoding.

target => $recipients

Mandatory.

List of recipients to send message, comma delimited if there are more than one recipient:

  "+70010001212, 80009990000"

Mutualy exclusive with phl_codename

phl_codename => $phl_codename // ''

Mutualy exclusive with target, one or other is mandatory.

Codename of a recipient via contact-list created on https://go.qtelecom.ru.

sender => $sender // ''

Optional.

Sender's nickname, one of the registered on https://go.qtelecom.ru.

period => $period // ''

Optional.

Time-to-Live for a message, units are second. Message will be discarded if system fails to deliver message over this period of time.

  Caution: this service may not work for some routes, like a CDMA phones.
time_period => $time_period // ''

Optional.

Timeperiod during which message shall be delivered to the recipients (like 10:00-21:00). Use of this option allows to skip delivery of messages during night hours. For this service to work correctly you may specify time_local timezone.

time_local => $time_local // ''

Optional.

Selection of time zone for time_period option: 1 - means time_period is local time for the recipient, 0 - means time_period was specified according to the sender settings.

autotrimtext => $autotrimtext // ''

Optional.

Automatically trim leading and trailign spaces from a message.

status

    my $status_xml = $qtsms->status( sms_id => '359900000000000080' );

Returns an XML describing status of operation.

There are three ways to get a status: by sms_id, or by sms_group_id or by pair date_from and date_to.

sms_id => $sms_id

ID of the sms, taken from the tag ID in responce of sending SMS.

sms_group_id => $sms_group_id

ID of a group of sent messages, taken from tag SMS_GROUP_ID in responce of sendin one SMS or group of SMS.

date_from => $date_from, date_to => $date_to

Get status of all the messages sent during the timeframe given by date_from and date_to.

Format of the date is dd.mm.yyyy hh:ii:ss.

Period must start in less than 4 days before the current date.

AUTHOR

Pasichnichenko Konstantin, <pasichnichenko.k at gmail.com>

BUGS

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

SUPPORT

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

    perldoc SMS::API::QuickTelecom

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2016 Pasichnichenko Konstantin.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.