NAME
Net::Clickatell - Access to Clickatell HTTP API
This module support the API from Clickatell's HTTP API Specification v.2.4.1.
The following is all the available API and not all are supported
Basic Commands
http://api.clickatell.com/http/auth Yes (But session not support)
http://api.clickatell.com/http/ping Yes (But session not support)
Additional Commands
Batch Messaging
SYNOPSIS
With SSL
use
Net::Clickatell;
my
$clickatell
= Net::Clickatell->new(
API_ID
=>
$api_id
,
USERNAME
=>
$username
,
PASSWORD
=>
$password
);
my
$bal
=
$clickatell
->getBalance;
Without SSL
use
Net::Clickatell;
my
$clickatell
= Net::Clickatell->new(
UseSSL
=>0,
API_ID
=>
$api_id
,
USERNAME
=>
$username
,
PASSWORD
=>
$password
);
my
$bal
=
$clickatell
->getBalance;
DESCRIPTION
Clickatell (http://www.clickatell.com) is a commercial service that allows its users to send SMS messages to anyone in the world. This perl module allow users to send SMS, WAP push and MMS through Clickatell HTTP API.
Please take note that neither this software nor the author are related to Clickatell in any way.
METHODS
- new
-
This method is used to create the Clickatell object.
Usage:
my
$clickatell
= Net::Clickatell->new(
API_ID
=>
$api_id
, USERNAME=
$user
,
PASSWORD
=>
$passwd
);
The complete list of arguments is:
API_ID : Unique number received from Clickatell
when
an account is created.
BaseURL : Default URL used to
connect
with
Clickatell service.
UserAgent : Name of the user agent you want to display to Clickatell service.
- getBalance
-
This method will return the Balance of the account.
Usage:
$clickatell
->getBalance;
Succesful example of the return is as followed: OK: Credit: 100.3
Failed example of the return is as followed: ERR: 001, Authentication failed
- checkCoverage
-
This method will return the Balance of the account.
Usage:
$clickatell
->checkCoverage(
$msisdn
);
Succesful example of the return is as followed: OK: This prefix is currently supported. Messages sent to this prefix will be routed. Charge: 1
Failed example of the return is as followed: ERR: This prefix is not currently supported. Messages sent to this prefix will fail. Please contact support for assistance.
- getQuery
-
This method will return the Message Charge Status.
Usage:
my
(
$code
,
$querymessage
)=
$clickatell
->getQuery(
$apimsgid
);
This method will
return
2
values
in a array which is as followed:
001
ID: add8f5556c0d3d54bc94a4cd8800f01b4 Status: 001, Message unknown. The delivering network did not recognise the message type or content.
- getMessageCharge
-
This method will return the Message Charge Status.
Usage:
my
(
$code
,
$messagecharge
)=
$clickatell
->getMessageCharge(
$apimsgid
);
This method will
return
2
values
in a array which is as followed:
001
apiMsgId: add8f5556c0d3d54bc94a4cd8800f01b4 charge: 0 status: 001, Message unknown. The delivering network did not recognise the message type or content.
- sendBasicSMSMessage
-
This method is used to send a text SMS Message.
Usage:
my
$smsResult
=
$clickatell
->sendBasicSMSMessage(
$from
,
$to
,
$msg
);
Succesful example of the return is as followed: OK: ID: dd8f5556c0d3d54bc94a4cd8800f01b4
Failed example of the return is as followed: ERR: 105, Invalid Destination Address
- sendAdvanceSMSMessage
-
This method is used to send a customised SMS Message. The following are the accepted parameter format: to text from callback deliv_time concat max_credits req_feat queue escalate mo cliMsgId Unicode msg_type udh data validity binary schedule_time
Usage:
my
$smsResult
=
$clickatell
->sendAdvanceSMSMessage(
to
=>
'6591234567'
,
from
=>
'6591234568'
,
text
=>
'testing'
);
Succesful example of the return is as followed: OK: ID: dd8f5556c0d3d54bc94a4cd8800f01b4
Failed example of the return is as followed: ERR: 105, Invalid Destination Address
- sendMMNotification
-
This method is used to send a MMS Notification Push Message.
Usage:
my
$mmsResult
=
$clickatell
->sendMMNotification(
$from
,
$to
,
$subject
,
$expiry
,
$url
);
Succesful example of the return is as followed: OK: ID: dd8f5556c0d3d54bc94a4cd8800f01b4
Failed example of the return is as followed: ERR: 105, Invalid Destination Address
- sendWAPPush
-
This method is used to send a WAP Push. Currently, only SI WAP Push message is supported.
Usage:
my
$wapResult
=
$clickatell
->sendWAPPush(
$from
,
$to
,
$msg
,
$url
);
Succesful example of the return is as followed: OK: ID: dd8f5556c0d3d54bc94a4cd8800f01b4
Failed example of the return is as followed: ERR: 105, Invalid Destination Address
AUTHOR
Christopherus Goo <software@artofmobile.com>
COPYRIGHT
Copyright (c) 2010 Christopherus Goo. All rights reserved. This software may be used and modified freely, but I do request that this copyright notice remain attached to the file. You may modify this module as you wish, but if you redistribute a modified version, please attach a note listing the modifications you have made.
Clickatell is Copyright (c) 2010 Clickatell (Pty) Ltd: Bulk SMS Gateway
This software or the author aren't related to Clickatell in any way.
1 POD Error
The following errors were encountered while parsing the POD:
- Around line 534:
=back doesn't take any parameters, but you said =back 4