Download the PHP package karlmacz/chikka without Composer
On this page you can find all versions of the php package karlmacz/chikka. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package chikka
Chikka
Chikka SMS API package for Laravel 5.
Installation
Require this package in your project's composer.json
file.
Setup
Add the service provider to the providers
array in your project's config/app.php
file.
Add CHIKKA_ACCESS_CODE
, CHIKKA_CLIENT_ID
, CHIKKA_SECRET_KEY
, and CHIKKA_REQUEST_COST
in your project's .env
file.
CHIKKA_REQUEST_COST
's default value is FREE
, so no need to add this to your project's .env
file if you want chikka to decide how much credits will be deducted to the user's actual load.
Also, CHIKKA_STORE_TRANSACTIONS
is available with a default value of false
. When set to true
, all incoming and outgoing sms will be stored in the database. After setting it to true
, publish the migrations from this package.
This will add 2017_04_08_000000_create_chikka_incoming_sms_table.php
and 2017_04_08_000001_create_chikka_outgoing_sms_table.php
to your project's database/migrations
directory. After that, run the migrations.
Usage
Sending SMS to a user
To send an sms, make a HTTP POST Request to the /chikka/send
path.
message_type
parameter's value must be set to SEND
.
Replying to a SMS from users
To reply to an sms sent to you by the user, make a HTTP POST Request to the /chikka/send
path with an additional paramater request_id
.
message_type
parameter's value must be set to REPLY
. Also, request_id
parameter's value must be the same transaction ID indicated in the message you received.
/chikka/send
's named route chikka.send
is also available for you to use.
Receiving SMS from users
When CHIKKA_STORE_TRANSACTIONS
is set to true
in your project's .env
file, all incoming sms will automatically be saved to the database.
All you have to do now is to add /chikka/receive
path to the Message Receiver URL in the Chikka API Settings Page
Note
When making a HTTP POST Request to the /chikka/send
path using a Standard HTTP Request, the response is converted to a flash session that you may display by using session()->get()
.
But, when making a HTTP POST Request to the /chikka/send
path using AJAX, the response is encoded to JSON.
License
This package is licensed under the MIT License.
All versions of chikka with dependencies
illuminate/support Version 5.2.*
guzzlehttp/guzzle Version 6.2
symfony/psr-http-message-bridge Version 1.0