README

This package provides a simple and easy-to-use interface to send SMS and Whatsapp to any phone using twillo, and also support send whatsapp using whatsapp api in laravel applications.

Installation

You can install the package via Composer:

composer require bajjour/emessage-pkg

Configuration

After installing the package, publish the configuration file:

php .\artisan vendor:publish --provider="EMessage\EmessageServiceProvider" --tag="e-message-config"

if you need to integrate with twillo, Update your .env file with your Twillo account settings:

EMESSAGE_ACCOUNT_SID="your-twillo-account-sid"
EMESSAGE_AUTH_TOKEN="your-twillo-auth-token"
EMESSAGE_DEFAULT_SEND_NUMBER="your-send-number" #required when sending using phone number
EMESSAGE_DEFAULT_SEND_SERVICE="your-send-messaging-service-sid" #required when sending using service
EMESSAGE_SEND_WHATSAPP_NUMBER="your-whatsapp-sending-messaging" #required when sending using whatsapp

if you need to integrate with whatsapp api, Update your .env file with your meta account settings:

WHATSAPP_PHONE_NUMBER_ID="your-whatsapp-phone-number-id"
WHATSAPP_ACCESS_TOKEN="your-whatsapp-access-token"
WHATSAPP_APP_ID="app-id" #optional, required only with refresh token
WHATSAPP_APP_SECRET="app-secret" #optional, required only with refresh token

Twillo Usage

Initialize the Service

You can initialize EMessage service in your controller:

use EMessage\Services\EMessageService;

protected EMessageService $em_service;

public function __construct(EMessageService $em_service)
{
    $this->em_service = $em_service;
}

Send SMS using Phone Number

you can send sms using default send number that you entered in .env file.

$receive_mobile = '+970XXXXXXXXX'; //receive mobile with international code
$message = 'your message to your user';
$res = $this->em_service->send_sms_use_phone($receive_mobile, $message);

if you have multiple send numbers you can also pass send number to send_sms_use_phone function

$receive_mobile = '+970XXXXXXXXX'; //receive mobile with international code
$message = 'your message to your user';
$send_number = 'your_send_number';
$res = $this->em_service->send_sms_use_phone($receive_mobile, $message, $send_number);

Response

{
  "status":true,
  "message_sid":"message_sid"
}

Send SMS using Messaging Service

you can send sms using default send service that you entered in .env file.

$receive_mobile = '+970XXXXXXXXX'; //receive mobile with international code
$message = 'your message to your user';
$res = $this->em_service->send_sms_use_service($receive_mobile, $message);

if you have multiple "Messaging Services" you can also pass "send_service" to send_sms_use_service function

$receive_mobile = '+970XXXXXXXXX'; //receive mobile with international code
$message = 'your message to your user';
$send_service = 'your_messaging_service_sid';
$res = $this->em_service->send_sms_use_service($receive_mobile, $message, $send_service);

Response

{
  "status":true,
  "message_sid":"message_sid"
}

when sending sms fails you will receive another response like the following

{
  "status":false,
  "error":{
    "code":21705,
    "message":"The Messaging Service Sid xxx is invalid.",
    "more_info":"https:\/\/www.twilio.com\/docs\/errors\/21705",
    "status":400
  }
}

Send Whatsapp Message

you can send whatsapp using the following function.

$receive_mobile = '+970XXXXXXXXX'; //receive whatsapp number
$message = 'your message to your user';
$res = $this->em_service->send_whatsapp($receive_mobile, $message);

the response for sending whatsapp as the following

success

{
  "status": true,
  "response": {
    "account_sid": "your-sid",
    "api_version": "2010-04-01",
    "body": "sent-message",
    "date_created": "Sat, 19 Apr 2025 12:17:30 +0000",
    "date_sent": null,
    "date_updated": "Sat, 19 Apr 2025 12:17:30 +0000",
    "direction": "outbound-api",
    "error_code": null,
    "error_message": null,
    "from": "whatsapp:your-whatsapp-send-number",
    "messaging_service_sid": null,
    "num_media": "0",
    "num_segments": "1",
    "price": null,
    "price_unit": null,
    "sid": "sid",
    "status": "queued",
    "subresource_uris": {
      "media": "media json"
    },
    "to": "whatsapp:receive-mobile",
    "uri": "json-path"
  }
}

fail

{
  "status":false,
  "response_status":400,
  "response_body":{
    "code":63007,
    "message":"Twilio could not find a Channel with the specified From address",
    "more_info":"https:\/\/www.twilio.com\/docs\/errors\/63007",
    "status":400
  }
}

Whatsapp API Usage

Initialize the Service

You can initialize WhatsApp Service in your controller:

use EMessage\Services\WhatsAppService;

protected WhatsAppService $w_service;

public function __construct(WhatsAppService $w_service)
{
    $this->w_service = $w_service;
}

Send Whatsapp Template

you can send whatsapp template by calling send_template() function. like the following

$otp = 'random-digits';

$template_name = 'otp';
$mobile = '970xxxxxxxxx';
$lang_code = 'en_US';

$components = [
    [
        'type' => 'body',
        'parameters' => [
            [
                'type' => 'text',
                'text' => $otp
            ]
        ]
    ],
    [
        'type' => 'button',
        'sub_type' => 'url',
        'index' => '0',
        'parameters' => [
            [
                'type' => 'text',
                'text' => $otp
            ]
        ]
    ]
];

$res = $this->w_service->send_template($mobile, $template_name, $components, $lang_code);

Success Response

{
  "status":true,
  "response":{
    "messaging_product":"whatsapp",
    "contacts":[{
      "input":"970xxxxxxxxx",
      "wa_id":"970xxxxxxxxx"
    }],
    "messages":[{
      "id":"sent-message-id",
      "message_status":"accepted"
    }]
  }
}

Fail Response

{
  "status":false,
  "response":"Error Details"
}

Refresh Whatsapp Token

Sometimes Meta account provide you with short time token, using the following function, you can generate long time token that valid for 60 days.

Don't forget to set WHATSAPP_APP_ID, WHATSAPP_APP_SECRET in env before calling refresh_token.

Function refresh_token() can update "WHATSAPP_ACCESS_TOKEN" in your env file, just set $update_env = true.

$short_time_token = 'token....';
$update_env = false;

$res = $this->w_service->refresh_token($short_time_token, $update_env);

Success Response

{
  "status":true,
  "new_token": "new-60-days-token",
  "expires_in": "expire-day"
}

Fail Response

{
  "status":false,
  "response":"Error Details"
}

License

MIT

bajjour / emessage-pkg

Maintainers

Details