plivobundle's Introduction

PlivoBundle

Installation

Install with composer

    $ composer require fourlabs/plivo-bundle eightpoints/guzzle-bundle

Add these bundles to app/AppKernel.php

<?php
    //...
    $bundles = [
        // ...
        // FLPlivoBundle depends on GuzzleBundle and MisdPhoneNumberBundle
        // Add them if they're not already present in your $bundles
        new EightPoints\Bundle\GuzzleBundle\EightPointsGuzzleBundle(), 
        new Misd\PhoneNumberBundle\MisdPhoneNumberBundle(), 
        new FL\PlivoBundle\FLPlivoBundle(),    
    ];

Sample Configuration

app/config/config.yml

# Guzzle Configuration
eight_points_guzzle:
    clients:
        plivo: # configure plivo client
            base_url: 'https://api.plivo.com/v1/Account/%plivo_auth_id%/'
            headers:
                Accept: "application/json"
            options:
                auth:
                    - %plivo_auth_id% # user
                    - %plivo_auth_token% # password
                timeout: 30

# Plivo Configuration
fl_plivo:
  sms_incoming_class: AppBundle\Entity\SmsIncoming
  sms_outgoing_class: AppBundle\Entity\SmsOutgoing
  development_mode: true # if set to true, sms will not be sent - defaults to false

app/config/services.yml

guzzle.client.plivo:
  alias: eight_points_guzzle.client.plivo

app/config/routing.yml

fl_plivo:
    resource: "@FLPlivoBundle/Resources/config/routing.yml"
    prefix:   /

Suggested Implementation

Create an entity for your ORM/ODM (e.g. Doctrine) that extends \Plivo\Model\SmsIncoming
Create an entity that extends \Plivo\Model\SmsOutgoing
If you are using Doctrine, you can use the corresponding event listeners, by importing them.

# app/config/config.yml
imports:
    - { resource: "@FLPlivoBundle/Resources/config/event-listener/doctrine.yml"}

If you are using not using Doctrine, create your own event listeners and submit a pull request ;)
To receive SMS messages, follow the instructions from Plivo
Use the corresponding url for the route fl_plivo.post_message (If you imported the default routing file, without a prefix, this would be /api/v1.0/message)

License

PlivoBundle is licensed under the MIT license.

plivobundle's People

Contributors

Stargazers

Watchers

plivobundle's Issues

Validate texts to US and CA numbers

Text messages to US and CA numbers can only be sent from US and CA number respectively. Validation would be helpful to avoid exceptions.

New Plivo error codes

https://www.plivo.com/blog/introducing-sms-error-codes/

Status Webhook always flags delivered

The status webhook is called with the status of the message including "queued", "sent", "failed", "delivered", "undelivered" or "rejected". The correct status along with units and error code should be saved.

The URL to which with the status of the message is sent. The following parameters are sent to the URL:
To - Phone number of the recipient
From - Phone number of the sender
Status - Status of the message including "queued", "sent", "failed", "delivered", "undelivered" or "rejected"
...
Units - Number of units into which a long SMS was split
ErrorCode - Delivery Response code returned by the carrier attempting the delivery. See Supported error codes below.

https://www.plivo.com/docs/api/message/

Recommend Projects