https://github.com/kianmeng/webservice-mocean

The Perl helper library for Mocean API, https://moceanapi.com/
https://github.com/kianmeng/webservice-mocean

api cpan mocean perl sms

Last synced: 14 days ago
JSON representation

The Perl helper library for Mocean API, https://moceanapi.com/

• Host: GitHub
• URL: https://github.com/kianmeng/webservice-mocean
• Owner: kianmeng
• License: other
• Created: 2018-08-19T11:15:13.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-26T16:42:25.000Z (almost 6 years ago)
• Last Synced: 2024-12-01T00:07:40.824Z (2 months ago)
• Topics: api, cpan, mocean, perl, sms
• Language: Perl
• Size: 48.8 KB
• Stars: 0
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Cpan license](https://img.shields.io/cpan/l/WebService-Mocean.svg)](https://metacpan.org/release/WebService-Mocean)

[![Cpan version](https://img.shields.io/cpan/v/WebService-Mocean.svg)](https://metacpan.org/release/WebService-Mocean)

# 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](https://github.com/kianmeng/webservice-mocean).

How to contribute? Follow through the [CONTRIBUTING.md](https://github.com/kianmeng/webservice-mocean/blob/master/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 

# 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)