Skip to content

Commit 284c013

Browse files
committed
Updated README.md
Updated README.md with guide to matching notifications and reports with messages sent.
1 parent 060ccb3 commit 284c013

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -452,6 +452,9 @@ print_r($client->getPricing(MobiWeb\Rest\Client::OTP));
452452
```
453453

454454
### Asynchronous SMS API
455+
### Asynchronous SMS Flow
456+
To achieve better performance, messages you send With MobiWeb Asynchronous SMS API are validated and accepted instantly, but processed asynchronously. Once your messages are processed and submitted you will receive Status Notifications regarding the their status. Message Status Notifications are forwarded automatically, to your system / platform. When a message is processed by our SMS API Platform, the status information is immediately forwarded to your specified DLR Callback URL via a POST request (Status Notification Forwarding). After the messages are delivered or have reached their final status, our SMS API Platform immediately forwards the associated Delivery Reports to your specified DLR Callback URL via a POST request (DLR Forwarding).
457+
455458
### Send a single SMS
456459

457460
```php
@@ -605,6 +608,16 @@ header('HTTP/1.1 200 OK', true, 200);
605608
?>
606609
```
607610

611+
### Matching message status notifications and delivery reports with messages
612+
613+
Status notifications and delivery reports POST requests transmit the ```message id```, ```reference_code```, ```recipient phone``` and ```message status```.
614+
615+
Due to the asynchronous nature of the SMPP API, message id is not available when you submit a message for processing.
616+
617+
To match and cross-check messages submitted with their status notifications and delivery reports, please set ```reference_code``` when submitting messages and store it, so you can cross-check and match when you receive a notification and delivery report.
618+
619+
Alternatively, if you are not sending multiple messages to the same mobile numbers, you can use the ```recipient number``` to match reports with messages.
620+
608621
## Getting help
609622

610623
If you need help installing or using the library, please [contact us][MobiWebSupportCenter].
@@ -613,6 +626,6 @@ If you've instead found a bug in the library or would like new features added, g
613626

614627
[apidocumentation]: https://api.solutions4mobiles.com/sms-api.html
615628
[apiaccount]: https://www.solutions4mobiles.com/product/sms-messaging
616-
[smppaccount]: mailto:sales@solutions4mobiles.com?subject=Asynchronous+SMS+API+Test+Account+Request&body=Dear+Team,+please+provide+me+with+a+test+account+for+the+Asynchronous+SMS+API.
629+
[smppaccount]: mailto:sales@solutions4mobiles.com?subject=Asynchronous SMS API Test Account Request&body=Dear Team, please provide me with a test account for the Asynchronous SMS API.
617630
[webpanel]: https://sms.solutions4mobiles.com
618631
[MobiWebSupportCenter]: https://www.solutions4mobiles.com/support

0 commit comments

Comments
 (0)