Download the PHP package tarfin-labs/netgsm without Composer

On this page you can find all versions of the php package tarfin-labs/netgsm. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of tarfin-labs/netgsm

Informations about the package netgsm

Laravel Config Logo

Latest Version on Packagist GitHub Workflow Status Quality Score Total Downloads

Introduction

With this package, you can send easily Netgsm notifications with Laravel ^8.0. This package also provides some simple reporting.

This package requires PHP 8.2 or higher and Laravel 11.0 or higher.
For older versions of Laravel, please use version ^4.0.0 of this package!

Contents

Installation

You can install the package via composer:

Next, you should publish the Laravel config migration file using the vendor:publish Artisan command.

Setting up the Netgsm service

Add your Netgsm User Code, Default header (name or number of sender), and secret (password) to your .env:

NETGSM_USERCODE and NETGSM_SECRET is authentication information of netgsm. NETGSM_HEADER is default header (name or number of sender) of sms messages.

Usage

Service Methods

Sends an SMS message to the phone number on the message object passed as a parameter. If the message is sent successfully, a job id returned from the netgsm API service is returned.

Returns a collection based on the report object passed as a parameter.

Sms Sending with Using Notification Channel

In order to let your Notification know which phone number you are sending to, add the routeNotificationForNetgsm method to your Notifiable model e.g your User Model

You can use the channel in your via() method inside the notification:

You can add recipients (string or array)

You can also set the sending date range of the message. (It does not work on OTP messages.)

You can set authorized data parameter (It does not work on OTP messages.)

If this parameter passes as true, only SMS will be sent to phone numbers that have data permission.

Additionally, you can change the header.

You can use NetGsmOtpMessage instead of NetGsmSmsMessage to send an OTP message.

For more information on sending OTP messages Netgsm OTP SMS Documentation

Sms Sending with Using Netgsm Facade

You can also send SMS or OTP messages using Netgsm Facade directly:

Reporting

You can get SMS reports by date range or netgsm bulk id.

To receive a report, a report object must be created.

Available Report Interfaces:
Object Parameters
Method Description Type Required NetgsmSmsReport Support NetgsmSmsDetailReport Support
setStartDate() Start Date Carbon No Yes Yes
setEndDate() End Date Carbon No Yes Yes
setBulkId() Netgsm Job Id Integer No Yes Yes
setStatus() Message Status Integer No Yes No
setPhone() Phone Number String[] No Yes Yes
setHeader() Header String No Yes Yes
setVersion() API Version Integer No Yes Yes
Sample Usage

You can get the SMS report to passing the report object to the Netgsm::getReports method. If successful, SMS report results will be returned as a collection.

Fields in the report result may differ depending on the specified report type and the report version parameter sent.

Report Results

Field Version NetgsmSmsReport Support NetgsmSmsDetailReport Support
jobId All Yes Yes
message 1 No Yes
phone All Yes No
status All Yes Yes
operatorCode 2 Yes No
length 2 Yes No
startDate 2 Yes No
startTime 2 Yes No
endDate All No Yes
errorCode 2 Yes No
header All No Yes
total All No Yes

Account Balance

With this service, you can inquire the remaining balance of your netgsm account and the credit balances of your packages.

Remaining Balance

Returns the remaining money balance on netgsm account. (TL)

Usage:

Output:

Remaining Package Credits

Returns the credit balances of the packages defined in the relevant netgsm account.

Usage:

Output:

IYS Integration

With these services you can add and search any address to IYS.

Add Address

This service is used to add a phone number or email address to IYS using NetGsm IYS service.

Object Parameters
Method Description Type Required
setRefId() Reference id to query your request String No
setType() Communication type String Yes
setSource() Source of permission String Yes
setRecipient() phone number or email address String Yes
setStatus() Permission status String Yes
setConsentDate() Permission date Datetime (YYYY-MM-DD H:i:s) Yes
setRecipientType() Recipient type String Yes
setRetailerCode() Retailer code Integer No
setRetailerAccess() Retailer access Integer No
Usage
Response Parameters

Bulk Insert

Response Paramaters for Bulk Insert

Search Address

This service is used to search a phone number or email address on IYS using NetGsm IYS service.

Object Parameters
Method Description Type Required
setType() Communication type String Yes (if refId is set to null)
setRecipient() phone number or email address String Yes (if refId is set to null)
setRecipientType() Recipient type String Yes (if refId is set to null)
setRefId() Reference id to query your request String No
Usage
Response Parameters

Testing

Changelog

Please see CHANGELOG for more information about what has changed recently.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update the tests as appropriate.

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

Credits

License

Laravel Netgsm is open-sourced software licensed under the MIT license.

All versions of netgsm with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2|^8.3|^8.4
guzzlehttp/guzzle Version ^7.1
illuminate/support Version ^11.0|^12.0
illuminate/notifications Version ^11.0|^12.0
illuminate/translation Version ^11.0|^12.0
nesbot/carbon Version ^3.8.5
ext-simplexml Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package tarfin-labs/netgsm contains the following files

Loading the files please wait ....