README

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require nycorp/shortext-php

You can publish the config file with:

php artisan vendor:publish --tag="shortext-php-config"

This is the contents of the published config file:

return [
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="shortext-php-views"

Usage

Send message:

$sdk =  new ShortextClient(env('SHORTEXT_API_KEY'));
$builder = new MessageBuilder($phone, from: "<PHONE_ID>", lastname: $lastname);
$sdk->sendMessage($builder);

You can send text message with:

$builder->text("hello this is text message");

You can send media message with:

$builder->media("<YOUR FILE URL>", "document", "document.pdf", "Optional caption");
$builder->media("<YOUR FILE URL>", "audio");
$builder->media("<YOUR FILE URL>", "image", caption: "Optional caption");
$builder->media("<YOUR FILE URL>", "video", caption: "Optional caption");

You can send cta_url message with:

$builder->ctaUrl(
    bodyText: "Hello this is body text",
    url: 'https://shortext.ny-corp.io',
    urlCaption: 'Voire les détails'
);

You can send payment message with:

$builder->payment(
    desription: "The message to display with 200 characters max length",
    amount: 100,
    currency: "XAF",
    order_id: "<OPTIONAL ORDER ID>",
    callback_url: "<YOUR OPTIONAL CALLBACK URL>"
);

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

nycorp / shortext-php

Maintainers

Details