Download the PHP package abduselam/afromessage without Composer
On this page you can find all versions of the php package abduselam/afromessage. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package afromessage
Afro Message a Laravel(PHP) SDK
This SDK provides a convinient access to the Afro message API.
Installation
-
Put your api key and sender id in your .env
- Publish config file
Gettig started
Simple usage looks like this
Methods
This methods provides exactly the same functionality as the actual API of afromessage if you need detail on how it works browse Afromessage API
send
To send a text message to a phone number use this send method 2 Required argument.
- Recipient phone number.
- Message
- Optional parameters *
Paramater | Type | Description | |
---|---|---|---|
from | string | The value of the system identifier id if you have subscribed to multiple short codes. | |
sender | string | The value of Sender Name to use for this message. only for verified users | . You can put it in your .env to be used by default |
template | int | Indicates the message is a template id rather than the actual message | |
callback | string | The callback URL(GET) you want to receive SMS send progress. | |
method | string | http method POST or GET (defuld is POST) |
- Example
Bulk
To send a text message to a phone number use this send method 2 Required argument.
- Recipient phone numbers.
- Message
- Optional parameters *
Paramater | Type | Description | |
---|---|---|---|
from | string | The value of the system identifier id if you have subscribed to multiple short codes. | |
sender | string | The value of Sender Name to use for this message. only for verified users | . You can put it in your .env to be used by default |
campaign | int | The name of the campaign given for this bulk send. It will show in the list of campaigns and you can monitor the progress. | |
createCallback | string | our callback URL we will call whenever a message is queued for sending from the batch. This endpoint must be a POST endpoint that takes a JSON body. | |
statusCallback | string | Your usual status callback URL you use for the other endponts. It must be a GET endpoint and we will send message status as it changes states |
- Example
code
This method helps you to send a short code Whether you want to send a one time password (OTP) or put in place a two-factor-authentication in your systems.
1 Required argument.
- Recipient phone number.
- Optional parameters *
Paramater | Type | Description | |
---|---|---|---|
codeLength | int | The character length of the security code. Default is 4 | |
type | string | The type of code you want to send (numeric, alphanumeric, alphabet). Defult is numeric | |
timeToExpire | int | The number of seconds for this code to be expired (defualt 0 which is not expired.) | |
prefix | string | A message prefix that you can prepend to the code | |
postfix | string | A message postfix that you can append right after the code | |
spaceBefore | int | The number of empty spaces you want to add between generated code and message prefix.(default is 1) | |
spaceAfter | int | The number of empty spaces you want to add between generated code and message postfix.(default is 1) | |
from | string | The value of the system identifier id if you have subscribed to multiple short codes. | |
sender | string | The value of Sender Name to use for this message. only for verified users | . You can put it in your .env to be used by default. |
callback | string | The callback URL(GET) you want to receive SMS send progress. |
- Example
verify
Verification method to validate code to the corresponding phone number 1 Required argument.
- code.
- Optional parameters *
Paramater | Type | Description | |
---|---|---|---|
Recipient | string | phone number of the recipient. Either this or verificationCod | |
verificationCode | string | The verification Id you received when sending security codes | . |
- Example