वेबहुक के माध्यम से SendOTP एपीआई डिलीवरी रिपोर्ट कैसे प्राप्त करें

आप MSG91 प्लेटफ़ॉर्म पर वेबहुक (Webhook) सुविधा का उपयोग करके SendOTP API के माध्यम से भेजे गए OTP के डिलीवरी रिपोर्ट प्राप्त कर सकते हैं। इसे सेटअप करने के लिए नीचे दिए गए चरणों का पालन करें:

1. अपने MSG91 डैशबोर्ड में लॉगिन करें » OTP » Webhook » फिर Create Webhook पर क्लिक करें।

2. अपने वेबहुक को कॉन्फ़िगर करें

चरण 1: अपने वेबहुक को एक नाम दें।

चरण 2: OTP चुनें और ईवेंट प्रकार “On Report Received” चुनें:

On Report Received: रियल-टाइम डिलीवरी रिपोर्ट प्रदान करता है, जिसमें सफलता/विफलता की स्थिति और अतिरिक्त विवरण शामिल होते हैं।

चरण 3: अपना Webhook URL (Callback URL) दर्ज करें जहाँ डेटा भेजा जाना चाहिए।

Content-Type: केवल JSON समर्थित है। सुनिश्चित करें कि आपका endpoint किसी भी JSON फ़ॉर्मेट में डेटा पार्स कर सके।

चरण 4: डेटा पैरामीटर कस्टमाइज़ करें

उस फ़ील्ड/पैरामीटर को जोड़ने के लिए { का उपयोग करें जिसे आप प्राप्त करना चाहते हैं।

आप आवश्यकतानुसार फ़ील्ड शामिल या हटाए जा सकते हैं। सुनिश्चित करें कि पैरामीटर वैध JSON फॉर्मेट का पालन करते हैं।

उपलब्ध सभी पैरामीटर के साथ उदाहरण JSON पेलोड:

{

  "CRQID": "{{CRQID}}",

  "requestedAt": "{{requestedAt}}",

  "requestId": "{{requestId}}",

  "telNum": "{{telNum}}",

  "countryName": "{{countryName}}",

  "status": "{{status}}",

  "senderId": "{{senderId}}",

  "deliveryTime": "{{deliveryTime}}",

  "credit": "{{credit}}",

  "smsLength": "{{smsLength}}",

  "pauseReason": "{{pauseReason}}",

  "voiceRetryCount": "{{voiceRetryCount}}",

  "otpRetry": "{{otpRetry}}",

  "verified": "{{verified}}",

  "failureReason": "{{failureReason}}",

  "userIp": "{{userIp}}",

  "flowID": "{{flowID}}",

  "DLT_TE_ID": "{{DLT_TE_ID}}",

  "campaignName": "{{campaignName}}",

  "telecomCircle": "{{telecomCircle}}",

  "circleDescription": "{{circleDescription}}"

}

पैरामीटर का वर्णन:

• CRQID
  एक कस्टम पैरामीटर जिसे आप API पेलोड में पास कर सकते हैं। आपको वेबहुक में वही मान प्राप्त होगा।
  उदाहरण: "CRQID": "MSG91SendOTPAPI"

• requestedAt
  टाइमस्टैम्प जो दर्शाता है कि संदेश अनुरोध आपके सिस्टम से कब आरंभ किया गया था।
  उदाहरण: "requestedAt": "2025-07-19T07:15:43.000Z"

• requestId
  प्रत्येक संदेश अनुरोध के लिए जनरेट किया गया अनूठा ID।
  उदाहरण: "requestId": "3567736c53515771356c4878"

• telNum
  उपयोगकर्ता का मोबाइल नंबर।
  उदाहरण: "telNum": "9177488479XX"

• countryName
  उस देश का नाम जहाँ OTP भेजा गया।
  उदाहरण: "countryName": "India"

• status
  संदेश की स्थिति – Delivered / Failed.
  1 = Delivered
  2 = Failed.
  उदाहरण: "status": "1"

• senderId
  SMS भेजने के लिए उपयोग किया गया Sender ID।
  उदाहरण: "senderId": "TXTAPI"

• deliveryTime
  टाइमस्टैम्प जो दर्शाता है कि SMS कब डिलीवर हुआ।
  उदाहरण: "deliveryTime": "2025-07-19T12:45:44.000Z"

• credit
  भेजे गए SMS के लिए कुल चार्ज जो काटे गए।
  उदाहरण: "credit": "0.22"

• smsLength
  आपके SMS के कैरेक्टर काउंट के आधार पर कटे गए क्रेडिट की संख्या।
  उदाहरण: "smsLength": "1”

• pauseReason
  OTP अनुरोध रोक दिए जाने का कारण।
  उदाहरण: "pauseReason": ""

• voiceRetryCount
  Voice कॉल के माध्यम से OTP कितनी बार पुनः भेजा गया।
  उदाहरण: "voiceRetryCount": "2"

• otpRetry
  OTP कितनी बार पुनः भेजा गया।
  उदाहरण: "otpRetry": "2"

• verified
  यह दर्शाता है कि OTP VerifyOTP API के माध्यम से सत्यापित हुआ था या नहीं। 1 = सत्यापित, खाली = सत्यापित नहीं।
  उदाहरण: "verified": "1"

• failureReason
  आपके SMS की विफलता का कारण।
  उदाहरण: "failureReason": "Absent Subscriber"

• userIp
  वह IP पता जिससे अनुरोध भेजा गया था।
  उदाहरण: "userIp": "54.86.50.139”

• flowID
  आपके OTP टेम्पलेट का MSG91 टेम्पलेट ID।
  उदाहरण: "flowID": "63ef3040d6fc054462756d53"

• DLT_TE_ID
  आपके संदेश का DLT टेम्पलेट ID।
  उदाहरण: "DLT_TE_ID": "1307160975559044358"

• campaignName
  उस टेम्पलेट का नाम जिसे आपने OTP भेजने के लिए उपयोग किया।
  उदाहरण: "campaignName": "Login_OTP"

• telecomCircle
  ग्राहक के मोबाइल नंबर का टेलीकॉम सर्कल।
  उदाहरण: "telecomCircle": "Madhya Pradesh & Chhattisgarh"

• circleDescription
  टेलीकॉम सर्कल का विवरण।
  उदाहरण: "circleDescription": "State of Madhya Pradesh and State of Chhattisgarh"

Webhook पर प्राप्त डेटा का उदाहरण पेलोड:

{

  "CRQID": "0",

  "requestedAt": "2025-07-19T06:56:28.000Z",

  "requestId": "3567736c7a4164736a357955",

  "telNum": "917748847990",

  "countryName": "India",

  "status": "1",

  "senderId": "TXTAPI",

  "deliveryTime": "2025-07-19T12:26:29.000Z",

  "credit": "0.22",

  "smsLength": "1",

  "pauseReason": "",

  "voiceRetryCount": "",

  "otpRetry": "",

  "verified": "",

  "failureReason": "",

  "userIp": "2600:1900:0:3902::700",

  "flowID": "63ef3040d6fc054462756d53",

  "DLT_TE_ID": "1307160975559044358",

  "campaignName": "Testing",

  "telecomCircle": "Madhya Pradesh & Chhattisgarh",

  "circleDescription": "State of Madhya Pradesh and State of Chhattisgarh"

}

आप key-value जोड़ी में Headers जोड़ भी सकते हैं, और हम इन Headers सहित सभी रिपोर्ट भेजेंगे:

अंतिम चरण: वेबहुक सहेजने के लिए Create पर क्लिक करें।

क्या अभी भी प्रश्न हैं?

हमें कॉल या WhatsApp पर +91 731 691 4364 पर बेझिझक संपर्क करें, या ईमेल भेजें: [email protected].