NAME

API::Intis - intistele.com API Client

VERSION

version 1.00

SYNOPSIS

use API::Intis;

my $ballance = API::Intis::APIRequest->new('balance', [\%addition_params]);

Description

The Intis telecom gateway lets you send SMS messages worldwide via its API. This program sends HTTP(s) requests and receives information as a response in JSON and/or XML. The main functions of our API include:

• sending SMS messages (including scheduling options);
• receiving status reports about messages that have been sent previously;
• requesting lists of authorised sender names;
• requesting lists of incoming SMS messages;
• requesting current balance status;
• requesting lists of databases;
• requesting lists of numbers within particular contact list;
• searching for a particular number in a stop list;
• adding new templates;
• requesting monthly statistics;
• making HLR request;
• HLR request
• receiving HLR request statistics;
• requesting an operator’s name by phone number;

To begin using our API please apply for your account at our website where you can get your login and API key.

Usage

Configiration

1. Create and/or Edit config file - config.yaml
   • login : you login
   • APIKey : you API key
2. Set additional options in the hash.

            

              
              
my %addition_params = (state=> '6546546654');
            
          

API

1. use API::Intis
2. Call API with method

            

              
              
my $ballance = APIRequest->new('balance');
            
          

where ('balance') - method. Look list of methods.

$ballance - for example object name.

1. Call API with method with additional options

            

              
              
my $ballance = APIRequest->new('balance', \%addition_params);
            
          

Note: list if additional options. Look list of methods.

The names of the method are the name .php file

The response object contains the following attributes:

• Request is in the form of JSON

            

              
              
$ballance->{request_json};
            
          

• Request is in the form of XML

            

              
              
$ballance->{request_xml};
            
          

• Requested text description of the error

            

              
              
$ballance->{error};
            
          

• Requested hash

            

              
              
$ballance->{request_object};
            
          

• Requested outgoing format

            

              
              
$ballance->{out_format};
            
          

• Requested method

            

              
              
$ballance->{method};
            
          

Aviable methods

| Method | Description | Has Base / Additional params | |----------|:-------------:|-------------:| | balance | Balance request | Base | | base | Lists request | Base | | senders | Request for senders list | Base | | phone | Request for numbers from list | Base + Additional (base, page)| | status | Status request | Base + Additional (state)| | send | SMS sending | Base + Additional (phone, text, sender, sendingTime)| | find_on_stop | Search in the blacklist | Base + Additional (phone)| | add2stop | Adding a number to the blacklist | Base + Additional (phone)| | add_template | Adding a template | Base + Additional (name, text, override) | | del_template | Deleting a template | Base + Additional (name) | | stat_by_month | General statistics for a month | Base + Additional (month) | | hlr | HLR request | Base + Additional (phone) | | hlr_stat | Statistics of HLR requests | Base + Additional (from, to) | | operator | Mobile operator query | Base + Additional (phone, text) | | incoming | Request for incoming SMS | Base + Additional (date, from, to) | | prices | Request for prices | Base |

Base params - login, signature, timestamp. Param login and signature - is is obtained from the configuration file. Look of configuration, timestamp - is obtained automatically.

AUTHOR

Nick Nomos nnmos@cpan.org

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Nick Nomos. GNU GPL 1991.

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