PHP download

Download the PHP package chroma-x/goyyamobile without Composer

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

Table of contents
Download chroma-x/goyyamobile
More information about chroma-x/goyyamobile
Files in chroma-x/goyyamobile

Vendor chroma-x
Package goyyamobile
Short Description Simple API abstraction for sending single SMS via Goyya Mobile.
License MIT
Homepage http://chroma-x.de/

Keywords sms Goyya

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 chroma-x/goyyamobile

Informations about the package goyyamobile

PHP Goyya Mobile simple API

Simple API abstraction for sending single short messages via Goyya Mobile.

Installation

Usage

Autoloading and namesapce

Sending a single short message

API Client authentication

Authentication against the Goyya Mobile webservice requires a valid account ID and password or a valid auth token.

API Client authentication by account credentials

API Client authentication by auth token

Debug mode

If you enable the debug mode your messages will get submitted to your Goyya Mobile provider, but not transmitted to the receiver.

By default the debug mode is disabled.

Preparing the message meta data

Settings up the meta data requires the following properties.

The receivers mobile number in international format, f.e. +4915112345678
The senders name or mobile number in international format. Sender information should contain characters [a-z,A-Z,0-9] without whitepace only. Mobile numbers are allowed up to a length of 16 digits whith leading 00. Sender names are allowed up to a length of 11 bytes.
If you want to delay the submission of the short message to a specific time, you can set the desired time by calling setSubmissionDate(YOUR_DESIRED_TIMESTAMP)method and enable the delayed submission by calling setDelayedSubmission(true).
If your account is not bound to a specific plan, you can choose the plan you want to use (and pay) message wise. Call the setSubmissionPlan method with one of the following class constants as argument.
- ChromaX\GoyyaMobile\Message::PLAN_BASIC
- ChromaX\GoyyaMobile\Message::PLAN_ECONOMY
- ChromaX\GoyyaMobile\Message::PLAN_QUALITY

Attention: Check your plan to make sure you are allowed to send short messages using a name instead of a mobile number.
By default the delayed submission if disabled.
The default plan is ChromaX\GoyyaMobile\Message::PLAN_BASIC.

Setting up the message content

The message content is set up by configuring the message type and content.

The message type defines how the content is handled. Call the setMessageType method with one of the following class constants to control how the messages content should get delivered.
- ChromaX\GoyyaMobile\Message::MESSAGE_TYPE_TEXT_SMS allows sending 160 bytes. Setting content above this range throws an ChromaX\GoyyaMobile\Exception\InvalidArgumentException.
- ChromaX\GoyyaMobile\Message::MESSAGE_TYPE_OVERLONG_SMS allows sending more than 160 bytes. If neccessary the content is submitted in multiple messages.
- ChromaX\GoyyaMobile\Message::MESSAGE_TYPE_UTF8_SMS allows sending more than 160 bytes of unicode characters.
The message content is handled as defined by setMessageType.

The default message type is ChromaX\GoyyaMobile\Message::MESSAGE_TYPE_TEXT_SMS.
Check the GSM 7-bit default alphabet to make sure your content will be displayed as expected at the receivers phone.

Submitting the message

The message gets submitted by calling the submit method.

Getting information about the submission

After a successful submission the Goyya Mobile message ID and the effective number of messages submitted are available.

Exception handling

Goyya Mobile simple API provides different types of exceptions.

\InvalidArgumentException is thrown on calling a setter with an invalid argument.
ChromaX\CommonException sub class exceptions get thrown if requesting the webservice of your Goyya Mobile provider fails for any reason.

You can find more information about PHP Common Exceptions at Github.

All exceptions have a specific code to allow you to handle the exceptions properly.

Exception	Code	Description
\InvalidArgumentException	10	Receiver is no valid international mobile number; starts not with `+` or `00`
\InvalidArgumentException	11	Receiver is no valid international mobile number; does contain non digit characters
\InvalidArgumentException	20	Sender is not valid; does contain non [a-z,A-Z,0-9] characters
\InvalidArgumentException	21	Sender is not a valid mobile number; it contains digits only but is longer than 16 bytes
\InvalidArgumentException	22	Sender is not a valid name; it contains alphanumeric characters but is longer than 11 bytes
\InvalidArgumentException	30	Message content is not valid; it is longer than 160 bytes but the message type is set to `ChromaX\GoyyaMobile\Message::MESSAGE_TYPE_TEXT_SMS`
ChromaX\CommonException\NetworkException\Base\NetworkException	40	HTTP request failed
ChromaX\CommonException\ApiException\InvalidResponseException	41	Response HTTP status code is not in the `2xx` range
ChromaX\CommonException\ApiException\Base\ApiException	42	The Goyya Mobile provider webservice responded with an error
ChromaX\CommonException\ApiException\UnexpectedResponseException	43	The Goyya Mobile provider webservice responded with an unexpected and therefore not parsable response body

Full example

Contribution

Contributing to our projects is always very appreciated.
But: please follow the contribution guidelines written down in the CONTRIBUTING.md document.

TODOs

~~Decorate the code base with some unit tests.~~
~~Publish contribution guidelines.~~
~~Add TokenAuth based authentication instead of using account ID and password as credentials.~~
Extend the basic API by some other useful methods like removing pending messages and sending bulk messages.

License

PHP Goyya Mobile simple API is under the MIT license.

All versions of goyyamobile with dependencies

PHP Build Version

Package Version

Version 4.0.2 Release 18. Jan 2021
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of goyyamobile from vendor chroma-x

Requires php Version >=5.3
lib-curl Version *
chroma-x/common-exceptions Version ~3.0
chroma-x/basic-http-client Version ~3.0

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 chroma-x/goyyamobile contains the following files

Loading the files please wait ....