chroma-x/goyyamobile

Simple API abstraction for sending single SMS via Goyya Mobile.

4.0.2 2021-01-18 17:29 UTC

Requires

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

Requires (Dev)

• codeclimate/php-test-reporter: dev-master
• phpunit/phpunit: >=4.8.26

MIT

• Martin Brecht-Precht

• sms
• Goyya

README

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

Installation

{
   	"require": {
        "chroma-x/goyyamobile": "~4.0"
    }
}

Usage

Autoloading and namesapce

require_once('path/to/vendor/autoload.php');

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

$shortMessage = new ChromaX\GoyyaMobile\Message();
$shortMessage
	->setAccountId('GOYYA_ACCOUNT_ID')
	->setAccountPassword('GOYYA_ACCOUNT_PASSWORD');

API Client authentication by auth token

$shortMessage = new ChromaX\GoyyaMobile\Message();
$shortMessage->setAuthToken('GOYYA_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.

$shortMessage->setDebugMode(true);

Preparing the message meta data

Settings up the meta data requires the following properties.

• The receivers mobile number in international format, f.e. [phone]
• 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.

$shortMessage
	->setReceiver('RECEIVER_MOBILE_NUMBER')
	->setSender('SENDER_NAME_OR_MOBILE_NUMBER')
	->setDelayedSubmission(true)
	->setSubmissionDate(strtotime('+6 hours'))
	->setSubmissionPlan(ChromaX\GoyyaMobile\Message::PLAN_QUALITY);

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.

$shortMessage
	->setMessageType(ChromaX\GoyyaMobile\Message::MESSAGE_TYPE_OVERLONG_SMS)
	->setMessage('Curabitur blandit tempus porttitor. ÄÖÜß~');

Submitting the message

The message gets submitted by calling the submit method.

$shortMessage->submit();

Getting information about the submission

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

$messageId = $shortMessage->getMessageId();
$messageCount = $shortMessage->getMessageCount();

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.

Full example

require_once('path/to/vendor/autoload.php');

use ChromaX\CommonException;

try {
	$shortMessage = new ChromaX\GoyyaMobile\Message();
	$shortMessage
		->setAccountId('GOYYA_ACCOUNT_ID')
		->setAccountPassword('GOYYA_ACCOUNT_PASSWORD')
		->setDebugMode(true)
		->setReceiver('RECEIVER_MOBILE_NUMBER')
		->setSender('SENDER_NAME_OR_MOBILE_NUMBER')
		->setDelayedSubmission(true)
		->setSubmissionDate(strtotime('+6 hours'))
		->setSubmissionPlan(ChromaX\GoyyaMobile\Message::PLAN_QUALITY)
		->setMessageType(ChromaX\GoyyaMobile\Message::MESSAGE_TYPE_OVERLONG_SMS)
		->setMessage('Curabitur blandit tempus porttitor. ÄÖÜß~')
		->submit();
	echo 'Message ID ' . $shortMessage->getMessageId() . PHP_EOL;
	echo 'Message count ' . $shortMessage->getMessageCount() . PHP_EOL;
} catch (\InvalidArgumentException $exception) {
	echo $exception->getMessage() . PHP_EOL;
	echo $exception->getCode() . PHP_EOL;
} catch (CommonException\NetworkException\Base\NetworkException $exception) {
	echo $exception->getMessage() . PHP_EOL;
	echo $exception->getCode() . PHP_EOL;
} catch (CommonException\ApiException\Base\ApiException $exception) {
	echo $exception->getMessage() . PHP_EOL;
	echo $exception->getCode() . PHP_EOL;
}

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.