{"id":15286137,"url":"https://github.com/kianmeng/webservice-mocean","last_synced_at":"2025-03-23T21:22:03.696Z","repository":{"id":56833556,"uuid":"145296271","full_name":"kianmeng/webservice-mocean","owner":"kianmeng","description":"The Perl helper library for Mocean API, https://moceanapi.com/","archived":false,"fork":false,"pushed_at":"2019-04-26T16:42:25.000Z","size":50,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-29T04:42:47.253Z","etag":null,"topics":["api","cpan","mocean","perl","sms"],"latest_commit_sha":null,"homepage":null,"language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kianmeng.png","metadata":{"files":{"readme":"README.md","changelog":"Changes","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-19T11:15:13.000Z","updated_at":"2019-06-20T08:28:29.000Z","dependencies_parsed_at":"2022-09-08T07:41:36.088Z","dependency_job_id":null,"html_url":"https://github.com/kianmeng/webservice-mocean","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kianmeng%2Fwebservice-mocean","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kianmeng%2Fwebservice-mocean/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kianmeng%2Fwebservice-mocean/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kianmeng%2Fwebservice-mocean/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kianmeng","download_url":"https://codeload.github.com/kianmeng/webservice-mocean/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245169889,"owners_count":20571973,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","cpan","mocean","perl","sms"],"created_at":"2024-09-30T15:10:45.643Z","updated_at":"2025-03-23T21:22:03.650Z","avatar_url":"https://github.com/kianmeng.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Cpan license](https://img.shields.io/cpan/l/WebService-Mocean.svg)](https://metacpan.org/release/WebService-Mocean)\n[![Cpan version](https://img.shields.io/cpan/v/WebService-Mocean.svg)](https://metacpan.org/release/WebService-Mocean)\n\n# NAME\n\nWebService::Mocean - Perl library for integration with MoceanSMS gateway,\nhttps://moceanapi.com.\n\n# SYNOPSIS\n\n    use WebService::Mocean;\n    my $mocean_api = WebService::Mocean-\u003enew(api_key =\u003e 'foo', api_secret =\u003e 'bar');\n\n# DESCRIPTION\n\nWebService::Mocean is Perl library for integrating with MoceanSMS gateway,\nhttps://moceanapi.com.\n\n# DEVELOPMENT\n\nSource repository at [https://github.com/kianmeng/webservice-mocean](https://github.com/kianmeng/webservice-mocean).\n\nHow to contribute? Follow through the [CONTRIBUTING.md](https://github.com/kianmeng/webservice-mocean/blob/master/CONTRIBUTING.md) document to setup your development environment.\n\n# METHODS\n\n## new($api\\_key, $api\\_secret, \\[%$args\\])\n\nConstruct a new WebService::Mocean instance. The api\\_key and api\\_secret is\ncompulsory fields. Optionally takes additional hash or hash reference.\n\n    # Instantiate the class.\n    my $mocean_api = WebService::Mocean-\u003enew(api_key =\u003e 'foo', api_secret =\u003e 'bar');\n\n    # Alternative way.\n    my $mocean_api = WebService::Mocean-\u003enew({api_key =\u003e 'foo', api_secret =\u003e 'bar'});\n\n### api\\_url\n\nThe URL of the API resource.\n\n    # Instantiate the class by setting the URL of the API endpoints.\n    my $mocean_api = WebService::Mocean-\u003enew({api_url =\u003e 'http://example.com/api/'});\n\n    # Alternative way.\n    my $mocean_api = WebService::Mocean-\u003enew(api_key =\u003e 'foo', api_secret =\u003e 'bar');\n    $mocean_api-\u003eapi_url('http://example.com/api/');\n\n## sms-\u003esend($params)\n\nSend Mobile Terminated (MT) message, which means the message is sent from\nmobile SMS provider and terminated at the to the mobile phone.\n\n    # Send sample SMS.\n    my $response = $mocean_api-\u003esms-\u003esend({\n        'mocean-to' =\u003e '0123456789',\n        'mocean-from' =\u003e 'ACME Ltd.',\n        'mocean-text' =\u003e 'Hello'\n    });\n\n## sms-\u003esend\\_verification\\_code($params)\n\nSend a random code for verification to a mobile number.\n\n    my $response = $mocean_api-\u003esms-\u003esend_verification_code({\n        'mocean-to' =\u003e '0123456789',\n        'mocean-brand' =\u003e 'ACME Ltd.',\n    });\n\n## sms-\u003echeck\\_verification\\_code($params)\n\nCheck the verification code received from your user.\n\n    my $response = $mocean_api-\u003esms-\u003echeck_verification_code({\n        'mocean-reqid' =\u003e '395935',\n        'mocean-code' =\u003e '234839',\n    });\n\n## account-\u003eget\\_balance()\n\nGet your Mocean account balance.\n\n    my $response = $mocean_api-\u003eaccount-\u003eget_balance();\n\n## account-\u003eget\\_pricing()\n\nGet your Mocean account pricing and supported destination.\n\n    my $response = $mocean_api-\u003eaccount-\u003eget_pricing();\n\n## report-\u003eget\\_message\\_status($params)\n\nGet the outbound SMS current status.\n\n    my $response = $mocean_api-\u003ereport-\u003eget_message_status({\n        'mocean-msgid' =\u003e 123456\n    });\n\n# AUTHOR\n\nKian Meng, Ang \u003ckianmeng@cpan.org\u003e\n\n# COPYRIGHT AND LICENSE\n\nThis software is Copyright (c) 2018-2019 by Kian Meng, Ang.\n\nThis is free software, licensed under:\n\n    The Artistic License 2.0 (GPL Compatible)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkianmeng%2Fwebservice-mocean","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkianmeng%2Fwebservice-mocean","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkianmeng%2Fwebservice-mocean/lists"}