https://github.com/digitregroup/php-myelefant-client
myElefant PHP Client - myElefant is able to send SMS, Facebook Messenger, Push, Viber, Wechat, RCS
https://github.com/digitregroup/php-myelefant-client
facebook-messenger myelefant php push rcs sdk sms viber wechat
Last synced: 5 months ago
JSON representation
myElefant PHP Client - myElefant is able to send SMS, Facebook Messenger, Push, Viber, Wechat, RCS
- Host: GitHub
- URL: https://github.com/digitregroup/php-myelefant-client
- Owner: digitregroup
- License: mit
- Created: 2019-01-24T14:48:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-10T06:23:30.000Z (almost 6 years ago)
- Last Synced: 2025-05-02T21:43:32.182Z (about 1 year ago)
- Topics: facebook-messenger, myelefant, php, push, rcs, sdk, sms, viber, wechat
- Language: PHP
- Homepage:
- Size: 385 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MyElefant
[](https://circleci.com/gh/digitregroup/php-myelefant-client)
[](https://packagist.org/packages/digitregroup/php-myelefant-client)
[](https://packagist.org/packages/digitregroup/php-myelefant-client)
MyElefant is a service for sending sms / push notifications etc...
https://myelefant.com/
This plugin is for sending sms campaigns with MyElefant's APIs.
https://platform.myelefant.com/api-doc.html
# Configuration
Php ^5.6
# Before use
**Get your secret key :**
Your MyElefant secret Key [here](https://platform.myelefant.com/user/options/)
**Create Campaign on MyElefant Inteface :**
The creation of a campaign is done by duplicating an existing one. You can customize your application on the myElefant interface and then automatically schedule similar campaigns to be sent.
**Get campaign UUID :**
When the campaign is created, a campaignId is created too.
This ID is displayed in the list of your campaigns when you click on "Show IDs".
# Installation
composer require digitregroup/php-myelefant-client
**Usage**
You can send a campaign with the parameters provided when creating the campaign (message and sender) or by using custom parameters.
**Create and send new campaign :**
- With your custom's parameters:
'***SECRET_KEY***'])
$client->sendSms
(
'campaignId',
'campaignName',
[['33612345678',(optional)'Name',(optional)'Surname']],
'2019-01-01 12:00',
'Your message',
'Your sender'
);
- With default template's parameters
'***SECRET_KEY***'])
$client->sendSms
(
'campaignId',
'campaignName',
[['33612345678',(optional)'Name',(optional)'Surname']],
'2019-01-01 12:00'
)
Field's formats :
- Secret Key :
String
- Campaign Id :
String
- Campaign name
String
- Contact :
Multidimensional array
Example: [['33611223344',(optionnal)'John',(optionnal)'Doe'],[...]]
- Send Date :
String
Example : 'Y-m-d H:i' -> '2019-01-25 12:59'
- Message :
String
- Sender :
String
**Send sms with existing campaign**
Important : To send SMS messages with custom fields, you must use tags when you create the campaign in the MyElefant interface.
Example :
[](https://image.noelshack.com/fichiers/2019/08/4/1550760212-doc.png)
then, in the code :
'***SECRET_KEY***'])
$client->sendSms(
'campaignId',
[
'33612345678',
'This content replace [[B]]',
'This content replace [[C]]',
'This content replace [[D]]'
]
);
To display phone number using [[A]] tag in your template.
# Debug
To activate logging system, add this parameter.
$client = new MyElefant(['secretKey' => '***SECRET_KEY***', 'debug'=> true])