Net::SMS::Clickatell::SOAP - SOAP interface to the Clickatell SMS service
Pure Perl module to access the Clickatell Bulk SMS gateway using the SOAP protocol.
use SMS::Clickatell::SOAP; my $sms = new SMS::Clickatell::SOAP( connection => ( proxy => $PROXY_URL, service => $SERVICE_URL, verbose => $VERBOSE, user => $WS_USER, password => $WS_PASSWD, api_id => 123456 ) );
Class constructor method instantiates a class object and initiates a connection to the Clickatell service through the auth call.
my $hSMS = new SMS::Clickatell::SOAP( proxy => $endpoint, service => "${endpoint}?wsdl", verbose => 0 );
where:
SOAP connection parameter. See SOAP::Lite for further information. Defaults to http://api.clickatell.com/soap/webservice.php.
SOAP connection parameter. See SOAP::Lite for further information. Defaults to http://api.clickatell.com/soap/webservice.php?wsdl.
Verbosity level for debugging. Default is verbose=>0 (only error output).
Convert a numeric error code to a text error message
numeric error code returned by the Clickatell API
associated text error message
Return the current session id
Send credentials to Clickatell to authenticate the session.
Clickatell user id
Clickatell password
Regisered API ID as assigned by Clickatell
The response will be:
Error returned by the Clickatell API
Send a ping to the service to keep the session alive.
where xxx is a numeric error code
Query the number of credits available in the account.
Amount of outstanding credit balance for the account.
Chck the coverage of a network or number without sending a message.
The network or number to be checked for coverage.
Eg. OK: This prefix is currently supported. Messages sent to this prefix will be routed. Charge: 0.33
API message id (apiMsgId) returned by the gateway after a message was sent.
client message ID (cliMsgId) you used on submission of the message.
the response will be:
eg. ID: 18e8221e5aa50cfad72376e08f40388a Status: 001;
Status codes are defined by the Clickatell API.
Query the status of a message.
the respones will be:
eg. apiMsgId: 18e8221e5aa50cfad72376e08f40388a charge: 0.33 status: 004;
Delete a previously sent message.
Chck the coverage of a network or number without sending a message. If item_user is supplied, then preexisting session authentication (if any) will be ignored and the item_user, item_pasword and api_id values will be used to authenticate this call. This allows you to send a message even if the existing session has dropped for any reason.
A phone number or list of phone numbers to recieve the messsage
The text of the message to be sent
eg. ID: 18e8221e5aa50cfad72376e08f40388a;
e.g. ERR: 105, Invalid Destination Address;
WAP Push Service Indication (SI) is a WAP address embedded within the header of a specially formatted SMS. This is displayed as an alert message to the user, and gives the user the option of connecting directly to a particular URL via the handsets WAP browser (if supported). This command enables you to send a WAP Push Service Indication.
Unique ID for each message
The URL used to access the service
eg. ID: ID: 18e8221e5aa50cfad72376e08f40388a TO: 99991234567;
SOAP::Lite, Clickatell SOAP API Specification V 1.1.8
Peter Farr <peter.farr@lpi-solutions.com>
Copyright (C) 2010 by Peter Farr
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.9 or, at your option, any later version of Perl 5 you may have available.
To install Net::SMS::Clickatell::SOAP, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::SMS::Clickatell::SOAP
CPAN shell
perl -MCPAN -e shell install Net::SMS::Clickatell::SOAP
For more information on module installation, please visit the detailed CPAN module installation guide.