SMS Webhooks

Overview

Netcore SMS Webhooks allow your system to receive real-time notifications for SMS events. Instead of manually checking the API, you can set up a callback URL where we will send data when an event occurs (e.g., SMS delivered, failed, etc.).

What are Webhooks?

Webhooks work like an API endpoint that your system provides to receive automated notifications. When a specific event happens, we send data to your webhook URL using GET or POST requests. This allows your system to process SMS updates instantly.


Supported Methods & Formats

Netcore SMS Webhooks support the following request methods:

  • GET
  • POST
  • JSON payload

Your webhook URL must be publicly accessible to receive these requests.

Securing Your Webhook

To ensure safe communication:

  • The webhook URL must be publicly accessible.
  • A HEAD request will be sent first to verify the URL (must return HTTP 200).
  • Once validated, actual event data is sent via GET or POST requests.

🔹 Tip: Secure your webhook using authentication (API key, token-based access, etc.) to prevent unauthorized access.


IP Whitelisting for Firewalls

If your system uses a firewall, whitelist the following IPs to allow webhook requests:

🚧 (IP list to be provided by Sakib)


Supported Events

Netcore webhooks provide updates on various SMS events. View the complete list here:

🔗 Supported Events

Additionally, webhooks also support:

  • DLT Chain Failure – SMS fails if TM-Chain registration is incomplete on the DLT portal.
  • DLT URL Failure – SMS fails if required URLs/APKs/OTT links are not whitelisted.
  • TM ID Failure – SMS fails if an invalid Telemarketer ID is used.

Webhook Configuration

To configure your webhook, follow these steps:

  1. Send an email to [[email protected]](mailto:[email protected]) with:
    • Webhook URL
    • Required parameters
    • Preferred API method (GET/POST)
  2. Our team will validate and activate your webhook.

Webhook Parameters

ParameterTypeSample ValueDescription
reqid or request_IDNumeric3453456723Acknowledgment ID from the SMS API call
mobileString9999999999Mobile number the SMS was sent to
delv_date or delivery_dateDateTime2025-03-03 09:01:18Date and time of SMS delivery
status or delivery_statusStringSuccess / FailedDelivery status of the SMS
feedidInteger234567Feed ID from which the SMS was sent

Handling Webhook Failures

If your webhook URL is down or not accepting requests, Netcore will retry based on the following logic:

If all retries fail, the webhook request is marked as failed with no further attempts.


Example Requests

GET Method Example

GET /sms/netcore/delivery_status?status=Invalidsubscriber&mobile=918754215121&feedid=388304&reqid=63341253481&delv_date=2025-03-03+09%3A01%3A18
Host: callback.okcredit.in

POST Method Example

POST /cbi_customized_pingback
Host: voicefibre.mytoday.com
Content-Type: application/json

{
  "phone_number": "918770157371",
  "delivery_time": "2025-03-03 09:20:02",
  "status_code": "000",
  "sms_sent_date": "2025-03-03 09:20:00.716",
  "unique_id": "299448250746343287",
  "status_description": "Success",
  "transaction_id": "21491126946"
}

Testing and Debugging Webhooks

Before deploying in production, test your webhook in a staging environment. Since RequestBin no longer provides a public version, you can use:

  • Webhook.site

  • Postman Webhook Tester

  • Self-hosted RequestBin

For setup and troubleshooting, contact our support team at [email protected]