ڈویلپر ڈاکیومنٹیشن

اس پر تعمیر کریں ٹیک پیڈ API۔

اپنے سسٹمز سے واٹس ایپ ٹیمپلیٹ پیغامات بھیجیں، ویب ہک کے ذریعے ڈیلیوری ایونٹس وصول کریں اور ہر درخواست کو لاگز میں مانیٹر کریں۔

مفت ورڈپریس پلگ انز

کوڈ کو چھوڑیں — ایک کنیکٹر پلگ ان انسٹال کریں۔

وہی واٹس ایپ بزنس API، آپ کے استعمال میں موجود ٹولز کے لیے مفت کنیکٹر پلگ انز میں لپٹی ہوئی — ہر فارم، بکنگ، ایونٹ اور اسٹور پلیٹ فارم براہ راست آپ کے واٹس ایپ پر بھیجتا ہے۔ انسٹال کریں، اپنے ای میل سے کنیکٹ کریں، مکمل۔

فوری شروع

چار مراحل میں صفر سے ایک ڈیلیور شدہ واٹس ایپ پیغام تک۔ یہاں سب کچھ ایپ کے اندر بھی کام کرتا ہے ڈویلپرز → جائزہ صفحہ، جو آپ کی پیشرفت کو ٹریک کرتا ہے۔

1

API کلید بنائیں

کھولیں ڈویلپرز → API کلیدیں ایپ میں اور ایک کلید بنائیں (پریفکس ttp_live_)۔ مکمل راز دکھایا جاتا ہے ایک بار — فوراً اس کی نقل کریں۔

2

ایک منظوری شدہ ٹیمپلیٹ منتخب کریں

آپ کے ورک اسپیس کو کم از کم ایک میٹا منظور شدہ ٹیمپلیٹ کی ضرورت ہے (دیکھیں نمونے). ٹیمپلیٹس براہِ راست میٹا سے تازہ ہوتی ہیں۔

3

ایک ٹیسٹ درخواست بھیجیں

ایپ میں استعمال کریں API ٹیسٹر یا نیچے دی گئی درخواست۔ وصول کنندہ نے آپ کے نمبر سے ٹیمپلیٹ پیغامات وصول کرنے کے لیے رضامندی ظاہر کی ہوگی۔

4

ڈلیوری ویب ہُک شامل کریں

اپنے HTTPS اینڈ پوائنٹ پر ایک ویب ہک پوائنٹ کریں، وہ ایونٹس منتخب کریں جن کی پرواہ آپ کرتے ہیں، اور دیکھیں ویب ہک لاگز ترسیل کی تصدیق کریں۔

تصدیق

API کو ہر ورک اسپیس کے API کیز کے ساتھ مستند بنایا جاتا ہے جو بیئرر ٹوکن کے طور پر بھیجی جاتی ہیں۔ کیز تخلیق اور منسوخ کی جاتی ہیں ڈویلپرز → API کلیدیں.

  • چابیاں شروع ہوتی ہیں ttp_live_ اور ایک ورک اسپیس تک محدود ہیں۔
  • ہر انٹیگریشن کے لیے الگ کلید بنائیں — ہر کلید اپنی خود کی نگرانی کرتی ہے last used ٹائم اسٹیمپ۔
  • پورا راز صرف تخلیق کے وقت ہی دکھایا جاتا ہے؛ اسے بعد میں بازیافت نہیں کیا جا سکتا۔ اس کی بجائے منسوخ کریں اور دوبارہ تخلیق کریں۔
  • چابی بھیجیں Authorization ہیڈر: Authorization: Bearer ttp_live_…
اپنی API کلید کبھی ظاہر نہ کریں کلائنٹ سائیڈ کوڈ، موبائل ایپس یا عوامی ریپوزٹریز میں۔ چابیاں صرف آپ کے اپنے سرورز اور محفوظ بیک اینڈ کے لیے ہیں۔

پیغام بھیجیں

اپنے ورک اسپیس کے جڑے ہوئے نمبر سے ایک منظوری شدہ واٹس ایپ ٹیمپلیٹ پیغام اس وصول کنندہ کو بھیجتا ہے جو عضو بن چکا ہو۔

پوسٹ https://v1.thetechpad.com/functions/v1/api-send

ہیڈر: Authorization: Bearer ttp_live_… · Content-Type: application/json

درخواست کا مواد

میدانقسمتفصیل
phoneNumberIdسٹرنگآپ کے ورک اسپیس میں مربوط واٹس ایپ نمبر کی شناخت (واٹس ایپ نمبرز کے صفحہ پر)۔
toسٹرنگموصول کنندہ کا فون نمبر E.164 فارمیٹ میں، مثلاً 15551234567.
template.nameسٹرنگآپ کے ورک اسپیس میں Meta کی منظور شدہ ٹیمپلیٹ کا نام، مثلاً order_update.
template.languageسٹرنگٹیمپلیٹ کی زبان کا کوڈ، مثلاً en.
template.parametersarray<string>ٹیمپلیٹ کے متغیرات کے لیے ترتیبی اقدار۔

درخواست کی مثال

curl -X POST 'https://v1.thetechpad.com/functions/v1/api-send' \
  -H 'Authorization: Bearer ttp_live_...' \
  -H 'Content-Type: application/json' \
  -d '{
  "phoneNumberId": "1122334455",
  "to": "15551234567",
  "template": {
    "name": "order_update",
    "language": "en",
    "parameters": ["Ava", "#4031"]
  }
}'
// JavaScript
const response = await fetch('https://v1.thetechpad.com/functions/v1/api-send', {
  method: 'POST',
  headers: { Authorization: 'Bearer ttp_live_...', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    phoneNumberId: '1122334455',
    to: '15551234567',
    template: { name: 'order_update', language: 'en', parameters: ['Ava', '#4031'] }
  })
});
ٹیمپلیٹ کے اصول لاگو ہوتے ہیں۔ پیغام کو منظور شدہ ٹیمپلیٹ استعمال کرنا ضروری ہے اور وصول کنندہ اہل ہونا چاہیے (چنا ہوا ہونا چاہیے)۔ میٹا ہر بھیجے گئے ٹیمپلیٹ پیغام کے لیے تصدیق کرتی ہے اور چارجز وصول کرتی ہے — یہ چارجز علیحدہ طور پر میٹا کی طرف سے بل کیے جاتے ہیں، آپ کے ٹیک پیڈ پلان کے باہر۔

ویب ہکس

آؤٹ باؤنڈ ویب ہُکس تقریباً حقیقی وقت میں آپ کے HTTPS اینڈ پوائنٹ پر پیغام کی لائف سائیکل ایونٹس بھیجتے ہیں۔ اینڈ پوائنٹس کو منیج کریں Developers → Webhooks — شامل کریں، ترمیم کریں، روکیں، ٹیسٹ کریں اور حذف کریں۔

ایونٹس

ایونٹاس وقت فائر ہوتا ہے جب
message.sentایک پیغام WhatsApp پلیٹ فارم کی طرف سے قبول کیا گیا اور بھیجا گیا۔
message.deliveredپیغام وصول کنندہ کے ڈیوائس پر پہنچایا گیا۔
message.readوصول کنندہ نے پیغام پڑھ لیا۔
message.failedپیغام ناکام ہوگیا (غیر قابل ترسیل، ٹیمپلیٹ مسترد، بھیجنے والے کی حد، …)۔
message.receivedکسٹمر کی طرف سے ایک اندرونی پیغام آیا۔
  • اینڈپوائنٹس ہونے چاہئیں HTTPS اور انٹرنیٹ سے قابل رسائی۔
  • ہر اینڈپوائنٹ منتخب کردہ ایونٹس کے ایک ذیلی سیٹ کو سبسکرائب کرتا ہے؛ ہر ایونٹ ایک JSON پی لوڈ کے ساتھ فائر ہوتا ہے جس میں میسج آئی ڈی اور اسٹیٹس شامل ہوتا ہے۔
  • استعمال کریں ٹیسٹ کریں کسی اینڈپوائنٹ پر ایک سیمپل ڈیلیوری بھیجنے کے لیے اور اپنے ہینڈلر کی جانچ کرنے کے لیے۔
  • معطل شدہ اینڈپوائنٹس اپنی کنفیگریشن برقرار رکھتے ہیں لیکن ایونٹس وصول کرنا بند کر دیتے ہیں۔

ریٹ کی حدیں

پیغامات آپ کے پلان کے پیکیج ریٹ پر بھیجے جاتے ہیں۔ حقیقی تھروپوٹ کم ہو سکتی ہے جب میٹا میسجنگ-ٹیئر، فون-کوالٹی یا اکاؤنٹ سطح کی حدود لاگو کرتا ہے۔ پیغامات باقی رہتے ہیں محفوظ طریقے سے قطار میں رکھا گیا بجائے اس کے کہ ضائع ہو جائے.

منصوبہماہانہ API کالزبنیادی بھیجنے کی شرح
کیمپین اسٹارٹر—فی منٹ زیادہ سے زیادہ 6 پیغامات
لانچ10,000پیکج کی شرح
گرو200,000پیکج کی شرح
اسکیل کریں2,000,000پیکج کی شرح

ہر درخواست آپ کے API کال کوٹے میں شمار ہوتی ہے اور اس کا اسٹیٹس کوڈ اور دورانیہ کے ساتھ API لاگز میں ریکارڈ کیا جاتا ہے.

لاگز اور نگرانی

ڈیولپرز → لاگز دو نظارے رکھتا ہے:

  • API لاگز — ہر API درخواست: طریقہ، اینڈ پوائنٹ، HTTP اسٹیٹس، استعمال شدہ ٹیمپلیٹ اور دورانیہ.
  • ویب ہک لاگز — ہر ویب ہوک ڈیلیوری کی کوشش اور اس کا نتیجہ۔

انہیں ناکام بھیجنے کی خرابی کو ڈیبگ کرنے، ویب ہوک ڈیلیوری کی تصدیق کرنے اور انٹیگریشنز کا آغاز سے آخر تک آڈٹ کرنے کے لیے استعمال کریں۔

غلطیاں

کامیاب درخواستیں ایک 2xx اسٹیٹس واپس کرتی ہیں۔ ناکامیاں ایک غیر 2xx اسٹیٹس کے ساتھ ایک JSON باڈی واپس کرتی ہیں جو مسئلے کی وضاحت کرتی ہے:

{
  "error": "Template not approved",
  "hint": "Check the template status in Templates — only APPROVED templates can be sent."
}
اسٹیٹسمعنی
2xxدرخواست قبول / پراسیس شدہ۔
400غلط ساخت والی درخواست — کھوئے ہوئے یا غیر درست فیلڈز۔
401کھویا ہوا یا غیر درست API کی۔
403کلید درست ہے لیکن اس عمل یا ورک اسپیس کے لیے اجازت نہیں ہے۔
404نامعلوم نمبر، ٹیمپلیٹ یا وسیلہ۔
429ریٹ لمٹ یا کوٹہ عبور ہو گیا — بیک آف کے بعد دوبارہ کوشش کریں۔
5xxپلیٹ فارم کی غلطی — دوبارہ کوشش کریں؛ API لاگز اور اسٹیٹس پیج چیک کریں۔

کنسول سے API آزما کر دیکھیں۔

ایپ میں API ٹیسٹر ہر درخواست کے لیے curl، JavaScript اور PHP جنریٹ کرتا ہے۔

ہم سے چیٹ کریں