NAME
WebService::Mocean - Perl library for integration with MoceanSMS gateway, https://moceanapi.com.
SYNOPSIS
use WebService::Mocean;
my $mocean_api = WebService::Mocean->new(api_key => 'foo', api_secret => 'bar');DESCRIPTION
WebService::Mocean is Perl library for integrating with MoceanSMS gateway, https://moceanapi.com.
DEVELOPMENT
Source repository at https://github.com/kianmeng/webservice-mocean.
How to contribute? Follow through the CONTRIBUTING.md document to setup your development environment.
METHODS
new($api_key, $api_secret, [%$args])
Construct a new WebService::Mocean instance. The api_key and api_secret is compulsory fields. Optionally takes additional hash or hash reference.
# Instantiate the class.
my $mocean_api = WebService::Mocean->new(api_key => 'foo', api_secret => 'bar');
# Alternative way.
my $mocean_api = WebService::Mocean->new({api_key => 'foo', api_secret => 'bar'});api_url
The URL of the API resource.
# Instantiate the class by setting the URL of the API endpoints.
my $mocean_api = WebService::Mocean->new({api_url => 'http://example.com/api/'});
# Alternative way.
my $mocean_api = WebService::Mocean->new(api_key => 'foo', api_secret => 'bar');
$mocean_api->api_url('http://example.com/api/');sms->send($params)
Send Mobile Terminated (MT) message, which means the message is sent from mobile SMS provider and terminated at the to the mobile phone.
# Send sample SMS.
my $response = $mocean_api->sms->send({
'mocean-to' => '0123456789',
'mocean-from' => 'ACME Ltd.',
'mocean-text' => 'Hello'
});sms->send_verification_code($params)
Send a random code for verification to a mobile number.
my $response = $mocean_api->sms->send_verification_code({
'mocean-to' => '0123456789',
'mocean-brand' => 'ACME Ltd.',
});sms->check_verification_code($params)
Check the verification code received from your user.
my $response = $mocean_api->sms->check_verification_code({
'mocean-reqid' => '395935',
'mocean-code' => '234839',
});account->get_balance()
Get your Mocean account balance.
my $response = $mocean_api->account->get_balance();account->get_pricing()
Get your Mocean account pricing and supported destination.
my $response = $mocean_api->account->get_pricing();report->get_message_status($params)
Get the outbound SMS current status.
my $response = $mocean_api->report->get_message_status({
'mocean-msgid' => 123456
});AUTHOR
Kian Meng, Ang <kianmeng@cpan.org>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2018-2019 by Kian Meng, Ang.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)