README

⚠️ Under Development 🚧

Introduction

This package integrate the Zenvia SMS Gateway API 2.0 with your PHP application, built with PSR-7 in mind.

Installation
Usage
License

Installation

Not work for now!

This project follow the psr-7 standards and no have a dependency of an specific HTTP client. You need require a library for send the Http requests manually, at your choice. Consult this list to find a client that support php-http/client-implementation. For more information about virtual packages please refer to Httplug. Example:

composer require php-http/guzzle6-adapter

Then install this package with composer:

composer require artesaos/zenvia-php

Usage

First, see the Zenvia API Documentation for view the structure of requests and responses.

Sending SMS

The class you need use for sending sms is the Artesaos\Zenvia\SMS.php. Let`s get started sending one sms:

$sms = new Artesaos\Zenvia\SMS('your_account','your_password');
$response = $sms->send(['id'=>'001','from'=>'sender','to'=>'phone_number','msg'=>'message']);

The send and sendMultiple method return for default a psr7 response, but you can choose the response type, passing a third argument to the send method. The second argument is a optional aggregateId parameter. The response type argument is a string and need to be one of: array,obj,string,stream,simple_xml or psr7(default). Example:

$sms = new Artesaos\Zenvia\SMS('your_account','your_password');
$response = $sms->send(['id'=>'001','from'=>'sender','to'=>'phone_number','msg'=>'message'],null,'simple_xml');

If you need convert your psr7 response to one of the response types manually, see the Changing The Response Format section.

Sending Multiple SMS

For sending multiple SMS at a time, use the sendMultiple method instead of send method. This method has the same signature:

$messages = [
    [
        'id'=>'001',
        'from'=>'sender',
        'to'=>'phone_number'
        'msg'=>'message'
    ],
    [
        'id'=>'002',
        'from'=>'sender',
        'to'=>'phone_number'
        'msg'=>'message'
    ],
];
$sms = new Artesaos\Zenvia\SMS('your_account','your_password');
$response = $sms->sendMultiple($messages);

Schedule SMS

You can schedule a text message to be sent passing a schedule attribute to the body of your sms:

$sms = new Artesaos\Zenvia\SMS('your_account','your_password');
$response = $sms->send(['id'=>'001','from'=>'sender','to'=>'phone_number','msg'=>'message','schedule'=>'15/04/2016 17:10:23']);

By default the Zenvia API accepts the ISO format, someting like this 2016-04-15T17:10:23. Thanks to Carbon extension for make this more easy. Instead of a ISO date string, you may pass a variety of formats accepted by Carbon.

Example:

+1 day
tomorrow 13:00
first day of April 17:10:23
this sunday 20:20:10
17:10:23
15/04/2016 17:10:23

You can use any format accepted by Carbon contructor(or parse method).See more options on the Carbon documentation

Check the status of a Delivered SMS

You can check the status of a delivered SMS using the check method. The first argument is the sms id and the second the response format:

$sms = new Artesaos\Zenvia\SMS('your_account','your_password');
$response = $sms->check($id, 'obj');

Changing The Response Format

If you need change the response format manually, use the Artesaos\Http\ResponseHandler class. Call the static convert method for convert your PSR-7 response to one of the formats above:

array,obj,string,stream,simple_xml

Note: The response to be converted must be a valid PSR-7 format!

$converted_response = Artesaos\Zenvia\Http\ResponseHandler::convert($response, $format);

Work in progress!

License

This project is open-source and licensed under the MIT license

artesaos / zenvia-php

Maintainers

Details