ഡെവലപ്പർ ഡോക്യുമെന്റേഷൻ

പ്പണിയുക ടെക് പാഡ് എപിไഐയിൽ.

നിങ്ങളുടെ സ്വന്തം സിസ്റ്റങ്ങളിൽ നിന്ന് വാട്ട്സ്ആപ്പ് ടെംപ്ലേറ്റ് സന്ദേശങ്ങൾ അയയ്ക്കുക, ഡെലിവറി ഇവന്റുകൾ വെബ്‌ഹുക്കിലൂടെ സ്വീകരിക്കുക, എല്ലാ അഭ്യർത്ഥനകളും ലോഗുകളിൽ നിരീക്ഷിക്കുക.

ഉത്സവ വേഡ്‌പ്രസ് പ്ലഗിനുകൾ

കോഡ് ഒഴിവാക്കുക — കണക്ടർ പ്ലഗിൻ ഇൻസ്റ്റാൾ ചെയ്യുക.

നിങ്ങൾ ഇതിനകം ഉപയോഗിക്കുന്ന ടൂളുകൾക്കായി സൗജന്യ കണക്ടർ പ്ലഗിനുകളിൽ ഉൾപ്പെടുത്തിയിട്ടുള്ള ഒരേ WhatsApp ബിസിനസ് API — ഓരോ ഫോം, ബുക്കിംഗ്, ഇവന്റ്, സ്റ്റോർ പ്ലാറ്റ്‌ഫോം നേരിട്ട് നിങ്ങളുടെ WhatsApp-ിലേക്ക് അയയ്ക്കുന്നു. ഇൻസ്റ്റാൾ ചെയ്യുക, നിങ്ങളുടെ ഇമെയിലുമായി ബന്ധിപ്പിക്കുക, പൂർത്തിയായത്.

വേഗത്തിലുള്ള ആരംഭം

ശൂന്യത്തിൽ നിന്ന് നാല് ചുവടുകൾ കൊണ്ട് ഒരു ഡെലിവർ ചെയ്ത WhatsApp സന്ദേശം വരെ. ഇവിടെ ഉള്ള എല്ലാത്തും ആപ്പ് ներ՗ടിയിൽ പ്രവർത്തിക്കുന്നു ഡെവലപ്പർമാർ → അവലോകനം നിങ്ങളുടെ പുരോഗതി പിന്തുടരുന്ന പേജ്.

1

ഏപി കെ കീ സൃഷ്ടിക്കുക

തെರೆದിടുക ഡവലപ്പർമാർ → API കീകൾ ആപ്പ്‌കളും ഒരു കീ (പ്രീഫിക്സ്) സൃഷ്‌ടിക്കുക ttp_live_). മുഴുവൻ രഹസ്യം കാണിക്കുന്നു ഒരു സമയത്ത് — ഇത് ഉടൻ തന്നെ കോപ്പി ചെയ്യുക.

2

അംഗീകൃത ടെംപ്ലേറ്റ് തിരഞ്ഞെടുക്കുക

നിങ്ങളുടെ വർക്ക്സ്പേസിന് കുറഞ്ഞത് ഒരു മെറ്റാ അംഗീകൃത ടെംപ്ലേറ്റ് വേണം (കാണുക ടെംപ്ലേറ്റുകൾ). ടെംപ്ലേറ്റുകൾ നേരിട്ട് മെറ്റയിൽ നിന്ന് പുതുക്കപ്പെടുന്നു.

3

ഒരു ടെസ്റ്റ് അഭ്യർത്ഥന അയയ്ക്കുക

ഇൻ-ആപ് ഉപയോഗിക്കുക എപിഐ ടെസ്റ്റർ അല്ലെങ്കിൽ താഴെയുള്ള അഭ്യർത്ഥന ഉപയോഗിക്കുക. ലഭിക്കുന്ന വ്യക്തി നിങ്ങളുടെ നമ്പറിൽ നിന്നും ടെംപ്ലേറ്റ് സന്ദേശങ്ങൾ സ്വീകരിക്കാൻ അംഗീകൃതനാകേണ്ടതാണ്.

4

ഡെലിവറി വെബ്‌ഹുക്കും ചേർക്കുക

ഒരു വെബ്‌ഹുക്കിനെ നിങ്ങളുടെ HTTPS എൻഡ്‌പോയിന്റിലേക്കു സൂചിപ്പിക്കുക, നിങ്ങൾക്ക് ആവശ്യമുള്ള ഇവന്റുകൾ തിരഞ്ഞെടുക്കുക, പിന്നെ കാണുക വെബ്‌ഹുക്ക് ലോഗുകൾ ഡെലിവറി സ്ഥിരീകരിക്കുക.

ഓതന്റിക്കേഷൻ

എപി.ഐ., വേർക്സ്‌പേസ് പ്രതീക്ഷിക്കുന്ന എപി.ഐ. കീകൾ ബെയറർ ടോക്കൻ ആയി അയച്ച് പ്രാമാണീകരിക്കുന്നു. കീകൾ സൃഷ്ടിക്കുകയും റദ്ദാക്കുകയും ചെയ്യുന്നു ഡവലപ്പർമാർ → API കീകൾ.

  • കീകൾ ആരംഭിക്കുന്നു ttp_live_ മറ്റ് ഒരു വർക്ക്‌സ്പേസിനോട് പരിമിതപ്പെടുത്തപ്പെടുകയും ചെയ്യുന്നു.
  • പ്രതിയൊറ്റ സംയോജനത്തിനും ഒരു വ്യത്യസ്ത കീ സൃഷ്‌ടിക്കുക — ഓരോ കിയും അതിന്റെ സ്വന്തം ട്ട്രാക്കിംഗ് നടത്തുന്നു last used ടൈംസ്റ്റാമ്പ്.
  • സമഗ്ര രഹസ്യം സൃഷ്ടിക്കുമ്പോഴേക്കുള്ള ഒരിക്കൽ മാത്രം പ്രദർശിപ്പിക്കപ്പെടുന്നു; പിന്നീട് ഇത് പുനരുദ്ധരിക്കാൻ കഴിയില്ല. പകരം റദ്ദാക്കി വീണ്ടും സൃഷ്ടിക്കുക.
  • ചാവി അയയ്ക്കുക Authorization ഹെഡർ: Authorization: Bearer ttp_live_…
നിങ്ങളുടെ API കീ कभी പുറത്തിറക്കരുത് ക്ലയന്റ്-സൈഡ് കോഡ്, മൊബൈൽ ആപ്പുകൾ അല്ലെങ്കിൽ പൊതുവായ റിപോസിറ്ററികളിൽ. കീകൾ നിങ്ങളുടെ സ്വന്തം സർവറുകൾക്കും സുരക്ഷിത ബാക്ക്എന്റുകൾക്കുമുള്ളവ മാത്രമാണ്.

ഒരു സന്ദേശം അയക്കുക

നിങ്ങളുടെ വർക്ക്‌സ്പേസിലെ കണക്റ്റ് ചെയ്ത നമ്പരിൽ നിന്ന് ഒരു ഒപ്റ്റ്-ഇൻ സ്വീകരിക്കുന്നയാളിക്ക് അംഗീകരിച്ച WhatsApp ടെംപ്ലേറ്റ് സന്ദേശം അയയ്ക്കുന്നു.

പോസ്റ്റ് https://v1.thetechpad.com/functions/v1/api-send

ഹെഡർ: Authorization: Bearer ttp_live_… · Content-Type: application/json

അഭ്യർത്ഥന ശരീരം

മൈതാനംടൈപ്പ്വിവരണം
phoneNumberIdസ്ട്രിംഗ്നിങ്ങളുടെ വര്‍ക്ക്‌സ്പേസിലുള്ള ഒരു ബന്ധിപ്പിച്ച WhatsApp നമ്പറിന്റെ ഐഡി (WhatsApp നമ്പറുകള്‍: പേജ്).
toസ്ട്രിംഗ്സ്വീകരണത്തിന്റെ ഫോൺ നമ്പർ E.164 ഫോർമാറ്റിൽ, ഉദാ. 15551234567.
template.nameസ്ട്രിംഗ്നിങ്ങളുടെ വർക്ക്‌സ്പേസിൽ മെറ്റാ അംഗീകൃത ടെംപ്ലേറ്റിന്റെ പേര്, ഉദാ. 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 എൻഡ്പോയിന്റിലേക്ക് സന്ദേശ ജീവിതചക്ര സംഭവങ്ങൾ പുഷ് ചെയ്യുന്നു. എൻഡ്പോയിന്റുകൾ നിയന്ത്രിക്കുക ഡവലപ്പർമാർ → വെബ്‌ഹൂക്കുകൾ — ചേർക്കുക, എഡിറ്റ് ചെയ്യുക, നിർത്തുക, പരിശോധന നടത്തുക, മായ്ക്കുക.

സംഭവങ്ങൾ

സംഭവംസജീവമാകുമ്പോൾ
message.sentഒരു സന്ദേശം WhatsApp പ്ലാറ്റ്‌ഫോം വഴി സ്വീകരിച്ച് അയച്ചു.
message.deliveredസന്ദേശം ലഭിക്കുപ്പെടുന്ന വ്യക്തിയുടെ ഉപകരണത്തിലേക്ക് തരണം ചെയ്തു.
message.readസ്വീകരിക്കുന്ന വ്യക്തി സന്ദേശം വായിച്ചു.
message.failedസന്ദേശം പരാജയപ്പെട്ടു (വിതരണയോഗ്യമല്ല, ടെംപ്ലേറ്റ് നിരസിച്ചു, അയയക്കാവുന്ന പരിധി, …).
message.receivedഒരു ഇന്റെർനെറ്റ് സന്ദേശം ഉപഭോക്താവിൽ നിന്ന് എത്തി.
  • എൻഡ്‌പോയിന്റുകൾ വേണം HTTPS മറ്റുള്ളവരിൽ നിന്നുള്ള ഇന്റർനെറ്റ് വഴി എത്തിച്ചേരാവുന്നതും.
  • ഓരോ എന്റ്പോയിന്റും തിരഞ്ഞെടുക്കപ്പെട്ട ഇവന്റുകളുടെ ഒരു ഉപസമിതിക്ക് സബ്സ്ക്രൈബ് ചെയ്യുന്നു; ഓരോ ഇവന്റും സന്ദേശ ഐഡി এবং സ്ഥിതിവിവരവുമായി JSON പേലോഡ് അടിച്ചുള്ള ഫയർ ചെയ്യുന്നു.
  • ഉപയോഗിക്കുക ടെസ്റ്റ് ഒരു എന്റ്പോയിന്റിൽ സാമ്പിൾ ഡെലിവറി അയച്ച് നിങ്ങളുടെ ഹാൻഡ്ലർ സ്ഥിരീകരിക്കാൻ.
  • പോസ് ചെയ്ത എന്റ്പോയിന്റുകൾ അവരുടെ കോൺഫിഗറേഷൻ നിലനിർത്തുന്നു പക്ഷേ ഇവന്റുകൾ സ്വീകരിക്കുന്നത് നിർത്തുന്നു.

വേഗത പരിമിതികൾ

സന്ദേശങ്ങൾ നിങ്ങളുടെ പ്ലാനിന്റെ പാക്കേജ് നിരക്കിൽ വരെ അയക്കപ്പെടുന്നു. മെറ്റാ മെസേജിംഗ്-ടിയർ, ഫോൺ-ക്വാളിറ്റി അല്ലെങ്കിൽ അക്കൗണ്ട്-തലത്തിലുള്ള പരിധികൾ പ്രയോഗിക്കുമ്പോൾ യഥാർത്ഥ ത്രൂപരുടെ കുറവാകാം. സന്ദേശങ്ങൾ തുടരുന്നു സുരക്ഷിതമായി നിരത്തിലാണ് വൃത്തിയാക്കപ്പെടുന്നതിനേക്കാൾ

പ്ലാൻഏപി.ഐ കോളുകൾ / മാസംഅടിച്ചുപഠിപ്പിക്കുന്ന പ്രതിസംഹാര നിരക്ക്
ക്യാമ്പെയിൻ സ്റ്റാർട്ടർ—പ്രതിമിനിറ്റ് 6 സന്ദേശങ്ങൾ വരെ
ലോഞ്ച്10,000പാക്കേജിന്റെ നിരക്ക്
വളർച്ച200,000പാക്കേജിന്റെ നിരക്ക്
സ്കേൽ2,000,000പാക്കേജിന്റെ നിരക്ക്

ഓരോ അഭ്യർത്ഥനയും നിങ്ങളുടെ API-കോൾ ക്വോട്ടയ്ക്ക് എണ്ണപ്പെടുന്നു കൂടാതെ അതിന്റെ സ്റ്റേറ്റസ് കോഡും ദൈർഘ്യവും ഉൾപ്പെടെ API ലോഗുകളിൽ രേഖപ്പെടുത്തിയിരിക്കുന്നു.

ലോഗുകളും മോണിറ്ററിംഗും

ഡെവലപ്പേഴ്സ് → ലോഗുകൾ രണ്ടു ദൃഷ്ടികോണങ്ങളും സൂക്ഷിക്കുന്നു:

  • എപിഐ ലോഗുകൾ — ഓരോ API അഭ്യർത്ഥനയും: മെത്തഡ്, എൻഡ്‌പോയിന്റ്, HTTP നില, ഉപയോഗിച്ച ടെംപ്ലേറ്റ്, ദൈർഘ്യം.
  • വെബ്‌ഹുക്ക് ലോഗുകൾ — ഓരോ വെബ്‌ഹുക്ക് ഡെലിവറി ശ്രമവും അതിന്റെ ഫലവും.

പരാജയപ്പെട്ട അയക്കലുകള്‍ ഡിബഗ് ചെയ്യാനും, വെബ്‌ഹുക്ക് ഡെലിവറി സ്ഥിരീകരിക്കാനും, ഇന്റഗ്രേഷനുകൾ അവസാനം അവസാനം ഓഡിറ്റ് ചെയ്യാനും അവ ഉപയോഗിക്കുക.

പിശകുകൾ

വിജയകരമായ അഭ്യർത്ഥനകൾ ഒരു 2xx സ്റ്റാറ്റസ് തിരികെ നൽകുന്നു. പരാജയങ്ങൾ ഒരു JSON ബോഡി ഉപയോഗിച്ച് പ്രശ്നം വിശദീകരിക്കുന്ന ഒരു non-2xx സ്റ്റാറ്റസ് തിരികെ നൽകുന്നു:

{
  "error": "Template not approved",
  "hint": "Check the template status in Templates — only APPROVED templates can be sent."
}
സ്റ്റാറ്റസ്അര്‍ത്ഥം
2xxഅഭ്യർത്ഥന സ്വീകരിച്ചു / പ്രോസസ്സ് ചെയ്തു.
400തെറ്റായ അഭ്യർത്ഥന — അഭാവമോ അസാധുവായ ഫീൽഡുകളോ.
401API കീ അഭാവമോ അസാധുവായതോ.
403ഈ പ്രവർത്തനത്തിനോ വർക്‌സ്പേസിനോ అనുമതിയില്ലാത്ത ശരിയായ കീ.
404അജ്ഞാത നമ്പർ, ടെംപ്ലേറ്റ് അല്ലെങ്കിൽ റിസോഴ്‌സ്.
429റേറ്റ് ലിമിറ്റ് അല്ലെങ്കിൽ ക്വോട്ടാ ലംഘിച്ചു — ബാക്ക്ഓഫ് ശേഷം വീണ്ടും ശ്രമിക്കുക.
5xxപ്ലാറ്റ്ഫോം പിശക് — വീണ്ടും ശ്രമിക്കുക; API ലോഗുകളും സ്റ്റാറ്റസ് പേജും പരിശോധിക്കുക.

കൺസോളിൽ നിന്ന് API പരീക്ഷിക്കുക.

അപ്‌യിലെയിലെ API ടെസ്റ്റർ എല്ലാ അപേക്ഷയ്ക്കും curl, JavaScript, PHP ജനറേറ്റ് ചെയ്യുന്നു.

ഞങ്ങളോടു ചാറ്റ് ചെയ്യുക