Skip to main content

Webhook Integration

We have introduced a webhook feature that allows you to receive SMS notifications for any number you have ordered. You can set a URL in your profile settings, and once an SMS is received for your number, it will be forwarded to your specified URL. This feature supports both single-service and long-term rentals.

Webhook Endpoint​

POST https://{yourserver.com}/newSms

Incoming Payload Schema​

The payload sent to your webhook URL will be a JSON object with the following structure:

{
  "user_id": "string",
  "country_code": "string",
  "number": "string",
  "sender": "string",
  "message": "string",
  "time_start": "string",
  "time_left": "string",
  "operation_id": "string",
  "code": "string"
}

Properties:

  • user_id (string): Your Profile's ID.
  • country_code (string): International country code of the number that received the SMS.
  • number (string): Phone number in international format.
  • sender (string): Sender's name or phone number.
  • message (string): SMS content.
  • time_start (string): Date and time when the operation was ordered.
  • time_left (string): Remaining time for the operation.
  • operation_id (string): Operation ID.
  • code (string): SMS ID.