Oblic

API సందేశాలు

మీ సంస్థ తరఫున ఇమెయిల్, SMS, WhatsApp సందేశాలు పంపండి. పత్రంలో పేర్కొన్న నిల్వ పరిమితుల్లో మళ్లీ ప్రయత్నించడానికి ఇడెంపోటెన్సీ కీని ఉపయోగించి, ప్రతి సందేశం ఫలితాన్ని విడిగా లేదా నివేదికలో చూడండి.

విజయవంతమైన పంపే అభ్యర్థన సాధారణంగా 202 Acceptedతో ID, స్థితిని ఇస్తుంది. స్వీకరించడం అంటే ప్రదాత ద్వారా చేరవేయడం కాదు: పంపడానికి అవుట్‌బౌండ్ డెలివరీ ప్రారంభమై ఉండాలి, ఛానల్ కన్స్యూమర్లు నడవాలి, ఛానల్ ప్రదాత కాన్ఫిగర్ అయి ఉండాలి. చేరే సమయానికి హామీ లేదు. అవుట్‌బౌండ్ డెలివరీ నిలిపివేసిన డిప్లాయ్‌మెంట్‌లో అభ్యర్థన స్వీకరించినా సందేశం పంపబడుతుందని కాదు. msg_ తర్వాత 32 హెక్సాడెసిమల్ అక్షరాలు ఉన్న IDతో ఇక్కడ లేదా వెబ్‌హుక్లో ఫలితాన్ని చదవవచ్చు.

202 స్వీకరించబడింది

{
  "status": "success",
  "data": { "id": "msg_4f9c2a1e8b7d4c3f9e0a1b2c3d4e5f60", "status": "queued" },
  "errors": null
}

POST/external/v1/messages/email

ఇమెయిల్ పంపడం

ఇమెయిల్ మీ సంస్థలో ధృవీకరించిన పంపేవారి గుర్తింపుల్లో ఒకదాని నుంచి, సొంత HTMLతో లేదా మీ ఇమెయిల్ టెంప్లేట్లలో ఒకదానితో రూపొందించిన HTMLతో వెళ్తుంది.

  • పేరు
    to
    టైప్ చేయండి
    string[]
    వివరణ

    cc లేదా bcc స్వీకర్తలను అందిస్తే ఐచ్ఛికం. to, cc, bcc కలిపి మొత్తం 1 నుంచి 50 చిరునామా ఎంట్రీలు ఇవ్వండి; ఏ ఒక్క జాబితా లేకపోవచ్చు లేదా ఖాళీగా ఉండవచ్చు. మొత్తం ఖాళీగా ఉంటే to వద్ద నిరాకరిస్తుంది.

  • పేరు
    cc
    టైప్ చేయండి
    string[]
    వివరణ

    Cc హెడర్ కోసం చిరునామాలు. ఇతర స్వీకర్తలకు అందే అదే ఇమెయిల్ విషయాన్ని వీరూ అందుకుంటారు.

  • పేరు
    bcc
    టైప్ చేయండి
    string[]
    వివరణ

    Bcc డెలివరీ జాబితా చిరునామాలు. పంపినవారి సందేశ రికార్డులు, webhooks లో Bcc దాచబడదు.

  • పేరు
    from
    టైప్ చేయండి
    string
    వివరణ

    ధృవీకరించిన గుర్తింపు చిరునామా లేదా ధృవీకరించిన డొమైన్ గుర్తింపులో ఏదైనా చిరునామా. ఇవ్వకపోతే సంస్థ యొక్క ధృవీకరించిన ప్రధాన పంపేవారు అవసరం; మరొక ధృవీకరించిన గుర్తింపును ప్రత్యామ్నాయంగా ఎంచుకోదు. Oblic గుర్తింపు తరఫున పంపినప్పుడు కనిపించే పంపేవారి చిరునామా ఆ గుర్తింపు చిరునామా కాకుండా, Oblicలో కాన్ఫిగర్ చేసిన పంపే డొమైన్‌లోని మారుపేరు.

  • పేరు
    fromName
    టైప్ చేయండి
    string
    వివరణ

    పంపేవారి పేరు, గరిష్ఠంగా 255 అక్షరాలు; <, >, " లేదా కొత్త పంక్తి ఉండకూడదు. ఇవ్వకపోతే గుర్తింపు ప్రదర్శన పేరును వాడుతుంది. గుర్తింపు తరఫున పంపినప్పుడు Oblic via Oblicను జోడిస్తుంది.

  • పేరు
    replyTo
    టైప్ చేయండి
    string
    వివరణ

    ప్రత్యుత్తరాలు వెళ్లే చిరునామా. Oblic గుర్తింపు తరఫున పంపినప్పుడు, replyTo మార్చకపోతే ప్రత్యుత్తరాలు అసలు ధృవీకరించిన చిరునామాకు వెళ్తాయి.

  • పేరు
    subject
    టైప్ చేయండి
    string
    వివరణ

    గరిష్ఠంగా 1,023 అక్షరాలు. htmlతో తప్పనిసరి. templateIdతో విషయం ఇవ్వకపోతే టెంప్లేట్ విషయాన్ని వాడుతుంది.

  • పేరు
    html
    టైప్ చేయండి
    string
    వివరణ

    ఇమెయిల్ HTML, ఇచ్చినట్లే పంపబడుతుంది. html లేదా templateId ఇవ్వండి; రెండూ కాదు.

  • పేరు
    text
    టైప్ చేయండి
    string
    వివరణ

    వచనం చూపే మెయిల్ క్లయింట్ల కోసం HTMLతో పంపే సాధారణ వచన వెర్షన్. templateIdతో దాని {{name}} ప్లేస్‌హోల్డర్లు variables నుంచి రాసినట్లే నింపబడతాయి; ఎస్కేప్ చేయబడవు.

  • పేరు
    templateId
    టైప్ చేయండి
    string
    వివరణ

    పంపాల్సిన ఇమెయిల్ టెంప్లేట్ ID, 18 ASCII అక్షరాలు మరియు అంకెలు.

  • పేరు
    variables
    టైప్ చేయండి
    object
    వివరణ

    templateIdతో టెంప్లేట్‌లోని ప్రతి {{name}} ప్లేస్‌హోల్డర్‌కు విలువ: గరిష్ఠంగా 100, ప్రతి విలువ గరిష్ఠంగా 10,000 అక్షరాల స్ట్రింగ్. పేర్లలో పెద్ద, చిన్న అక్షరాల తేడా పరిగణించదు. HTMLలో ఉంచినప్పుడు విలువ HTML-ఎస్కేప్ అవుతుంది; కాబట్టి <b>గా పంపిన వచనం <b>గానే కనిపిస్తుంది.

  • పేరు
    attachments
    టైప్ చేయండి
    object[]
    వివరణ

    గరిష్ఠంగా 10 ఫైళ్లు, ఒక్కొక్కటి {"fileName": …, "content": …} రూపంలో ఫైల్ బైట్లు base64 లో, మొత్తం గరిష్ఠంగా 10 MB. ZIP ఆర్కైవ్‌లు, CSV, ICS వంటి ఫైళ్లను అంగీకరించవచ్చు; SES తిరస్కరించే ఎక్స్‌టెన్షన్లు, గుర్తించిన అమలు చేయగల కంటెంట్ నిరాకరించబడతాయి. ప్రచార అప్‌లోడ్‌లకు ప్రత్యేక అనుమతి జాబితా కొనసాగుతుంది.

  • పేరు
    metadata
    టైప్ చేయండి
    object
    వివరణ

    ఆర్డర్ లేదా టెనెంట్ ID వంటి కీ ఆధారిత మీ సొంత స్ట్రింగ్‌లు, సందేశం మరియు దాని ప్రతి వెబ్‌హుక్‌తో తిరిగి వస్తాయి; స్వీకర్తలకు పంపబడవు. మెటాడేటా చూడండి.

స్వీకర్తల మూడు జాబితాలకూ ఒకే విషయం అందుతుంది. స్వీకర్తల హెడర్లలో To, Cc చిరునామాలు కనిపిస్తాయి; పంపినవారి సందేశ జాబితా, webhooks లో Bcc చిరునామాలు కూడా కనిపిస్తాయి. లెడ్జర్ ప్రతి స్వీకర్తకు To/Cc/Bcc పాత్రను నమోదు చేయదు.

ఈ జాబితాలకు API, Functions పంపిణీదారుడి అనుకూల సంస్కరణలు అవసరం. నవీకరించిన పంపిణీదారుణ్ని API కంటే ముందు లేదా దానితోపాటు సక్రియం చేయండి. అటాచ్‌మెంట్ స్కానింగ్ విడిగా కాన్ఫిగర్ చేసే తనిఖీ; అంగీకారం అంటే ఫైల్ స్కాన్ అయిందని లేదా మాల్వేర్ లేదని రుజువు కాదు.

సొంత HTMLతో ఇమెయిల్

curl -X POST https://api.oblic.app/external/v1/messages/email \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: order-1042-confirmation' \
  -d '{
    "from": "orders@example.com",
    "fromName": "Example Store",
    "to": ["asha@example.org"],
    "subject": "Your order is confirmed",
    "html": "<p>Thank you for your order.</p>"
  }'

టెంప్లేట్‌తో రూపొందిన ఇమెయిల్

curl -X POST https://api.oblic.app/external/v1/messages/email \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "to": ["asha@example.org"],
    "templateId": "TEM000R7ZM4Q2VXH00",
    "text": "Hi {{first_name}}, your order {{order_id}} is confirmed.",
    "variables": { "first_name": "Asha", "order_id": "1042" }
  }'

చందా రద్దు చేసిన లేదా నిరోధ జాబితాలో ఉన్న స్వీకర్తలు దాటవేయబడతారు: వారి సందేశం skipped అవుతుంది, email.suppressed వెబ్‌హుక్ కారణం చెబుతుంది.

తిరస్కరణcdఎప్పుడు
400ఫీల్డ్, ఉదాహరణకు TO[0]ఒక ఫీల్డ్ లేదు లేదా చెల్లదు; కలిపిన స్వీకర్తల సమితి ఖాళీగా లేదా పరిమితి కంటే పెద్దగా ఉంటే to వద్ద నిరాకరిస్తుంది
400INVALID_REQUESThtml, templateId రెండూ లేవు లేదా రెండూ ఉన్నాయి; టెంప్లేట్ లేకుండా variables ఉన్నాయి లేదా విషయం లేదు
400INVALID_VARIABLESప్లేస్‌హోల్డర్‌కు విలువ లేదు, పెద్ద చిన్న అక్షరాల తేడాతో పేరు రెండుసార్లు ఇచ్చారు లేదా నింపిన విషయం చాలా పొడవుగా ఉంది
400INVALID FILEఅటాచ్‌మెంట్ చాలా పెద్దది లేదా అనుమతించని రకం
403EMAIL_SUSPENDEDబౌన్స్‌లు లేదా స్పామ్ ఫిర్యాదుల కారణంగా ఖాతా ఇమెయిల్ నిలిపివేయబడింది; Oblic సహాయం ఆపివేతను తొలగించే వరకు ఇది కొనసాగుతుంది
413MESSAGE_TOO_LARGEఇమెయిల్ క్యూలో ఉంచలేనంత పెద్దది
422UNVERIFIED_SENDERfrom ధృవీకరించిన గుర్తింపుకు చెందినది కాదు; సందేశం ధృవీకరించిన గుర్తింపులను జాబితా చేస్తుంది
422TEMPLATE_NOT_FOUNDఆ IDతో ఇమెయిల్ టెంప్లేట్ లేదు
422TEMPLATE_HAS_MENTIONSటెంప్లేట్‌లో @unsubscribe వంటి డ్యాష్‌బోర్డ్ సూచనలు ఉన్నాయి; వాటిని ప్రచారాలు, ఆటోమేషన్లు మాత్రమే నింపుతాయి
429RATE_LIMITEDఖాతా గంట పరిమితి (డిఫాల్ట్‌గా 5,000 స్వీకర్తలు) లేదా ఒక చిరునామా పరిమితి (డిఫాల్ట్‌గా గంటకు 10) మించిపోయింది; ప్రతి పంపకంలో మూడు జాబితాల సాధారణీకరించిన ప్రత్యేక స్వీకర్తలను లెక్కిస్తారు, కాబట్టి ఆ పంపకంలో పునరావృత చిరునామా ఒక్కసారే లెక్కవుతుంది. Retry-After సమయాన్ని తెలియజేస్తుంది
429QUOTA_EXCEEDEDఖాతా నెలవారీ సందేశాల పరిమితి దాటింది (డిఫాల్ట్ 100,000); Retry-After మళ్లీ ప్రయత్నించే సమయం చెబుతుంది

రెప్యుటేషన్ వర్కర్ ప్రారంభమైతే, మార్చగల డిఫాల్ట్ సెట్టింగ్‌లు ప్రతి ఖాతా గత 7 రోజుల ఇమెయిల్‌ను 500 స్వీకర్తలకు పంపిన తర్వాత సమీక్షిస్తాయి: 2% బౌన్స్‌లు లేదా 0.05% స్పామ్ ఫిర్యాదుల వద్ద యజమానులకు హెచ్చరిక వస్తుంది; 4% లేదా 0.08% వద్ద Oblic సహాయం తొలగించే వరకు ఇమెయిల్ ఆపబడుతుంది. ఈ డిఫాల్ట్‌లతో స్పామ్ ఫిర్యాదులు 1,251 స్వీకర్తలకు పంపిన తర్వాతే అంచనా వేస్తారు; ఒక్క ఫిర్యాదుతో ఖాతా ఆపబడదు. శాశ్వత బౌన్స్‌లు మాత్రమే, ప్రతి స్వీకర్త ఒక్కసారి మాత్రమే లెక్కిస్తారు. ఆపిన లేదా నిలిపివేసిన వర్కర్ ఈ క్రమానుగత సమీక్ష చేయదు. ఖాతా ఆపబడినప్పుడు ఇమెయిల్ EMAIL_SUSPENDEDతో తిరస్కరించబడుతుంది; ముందే స్వీకరించి ఇంకా పంపని ఇమెయిల్ email.failed ఈవెంట్‌తో విఫలమవుతుంది; దాని failureCode EMAIL_SUSPENDED అవుతుంది.


POST/external/v1/messages/sms

SMS పంపడం

SMS భారతీయ మొబైల్ నంబర్‌కు వెళ్తుంది; ఖాతాకు అనుమతించిన DLT టెంప్లేట్లలో ఒకదానితో సరిపోవాలి: స్థిర వచనం పూర్తిగా ఒకేలా, ప్రతి వేరియబుల్ నింపి ఉండాలి. వచనం ఇస్తే Oblic టెంప్లేట్‌ను కనుగొంటుంది; లేదా టెంప్లేట్ DLT ID, వేరియబుల్స్ ఇవ్వండి.

  • పేరు
    to
    టైప్ చేయండి
    string
    వివరణ

    తప్పనిసరి: +91 తర్వాత పది అంకెలు; మొదటిది 6 నుంచి 9. ఖాళీలు, హైఫన్లు విస్మరించబడతాయి.

  • పేరు
    text
    టైప్ చేయండి
    string
    వివరణ

    సందేశం గరిష్ఠంగా 2,000 అక్షరాలు; మీ టెంప్లేట్‌లో వేరియబుల్స్ నింపిన రూపంగా ఉండాలి: ప్రతి వేరియబుల్ ఒక పంక్తిలో 1 నుంచి 30 అక్షరాలు. é లేదా ₹ వంటి సాధారణ ASCII వెలుపలి అక్షరాలు ఉన్న వచనం Unicode టెంప్లేట్లతో మాత్రమే సరిపోతుంది.

  • పేరు
    templateId
    టైప్ చేయండి
    string
    వివరణ

    textకు బదులుగా: టెంప్లేట్ DLT ID, గరిష్ఠంగా 32 అంకెలు.

  • పేరు
    variables
    టైప్ చేయండి
    string[]
    వివరణ

    templateIdతో: టెంప్లేట్‌లో ప్రతి వేరియబుల్‌కు క్రమంలో ఒక విలువ, గరిష్ఠంగా 30 విలువలు. ప్రతి విలువ ఒక పంక్తిలో 1 నుంచి 30 అక్షరాలు; Unicode టెంప్లేట్ కాకపోతే సాధారణ ASCIIలో ఉండాలి.

  • పేరు
    senderId
    టైప్ చేయండి
    string
    వివరణ

    పంపే DLT హెడర్, గరిష్ఠంగా 11 అక్షరాలు; టెంప్లేట్ హెడర్లలో ఒకటిగా ఉండాలి. ఇవ్వకపోతే ఖాతా డిఫాల్ట్ హెడర్‌కు ప్రాధాన్యం.

  • పేరు
    purpose
    టైప్ చేయండి
    string
    వివరణ

    otp, transactional (డిఫాల్ట్) లేదా promotional. ప్రచార సందేశం ప్రచార టెంప్లేట్లతో, ఇతరవి ప్రచారం కాని టెంప్లేట్లతో మాత్రమే సరిపోతాయి.

  • పేరు
    unicode
    టైప్ చేయండి
    boolean
    వివరణ

    Unicode టెంప్లేట్లను మాత్రమే పరిగణించడానికి true.

  • పేరు
    metadata
    టైప్ చేయండి
    object
    వివరణ

    ఆర్డర్ లేదా టెనెంట్ ID వంటి కీ ఆధారిత మీ సొంత స్ట్రింగ్‌లు, సందేశం మరియు దాని ప్రతి వెబ్‌హుక్‌తో తిరిగి వస్తాయి; స్వీకర్తలకు పంపబడవు. మెటాడేటా చూడండి.

ఒక SMS సందేశం

curl -X POST https://api.oblic.app/external/v1/messages/sms \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: login-7731' \
  -d '{
    "to": "+919812345678",
    "text": "Your Example code is 482913. It is valid for 10 minutes.",
    "purpose": "otp"
  }'

ఒక సెగ్మెంట్‌లో గరిష్ఠంగా 160 GSM-7 యూనిట్లు ఉంటాయి; ^ వంటి విస్తరణ అక్షరాలు రెండుగా లెక్కిస్తారు. Unicode SMSలో గరిష్ఠంగా 70 UTF-16 కోడ్ యూనిట్లు ఉంటాయి: ప్రాథమిక బహుభాషా తలం బయట అక్షరం రెండు వాడుతుంది. పొడవైన సందేశాలు 153 GSM-7 యూనిట్లు లేదా 67 UTF-16 కోడ్ యూనిట్ల సెగ్మెంట్లు వాడతాయి. ప్రచార SMS భారత కాలమానం 10:00తో మొదలై 21:00ను చేర్చని వ్యవధిలో మాత్రమే వెళ్తుంది. సైన్-ఇన్ కోడ్‌లు, లావాదేవీ మరియు సేవా SMSలు ఖాళీ వాలెట్ వల్ల తిరస్కరించబడవు.

తిరస్కరణcdఎప్పుడు
400INVALID_NUMBERto భారతీయ మొబైల్ నంబర్ కాదు
400INVALID_REQUESTtext, templateId రెండూ లేవు లేదా రెండూ ఉన్నాయి
400INVALID_VARIABLESవేరియబుల్స్ టెంప్లేట్‌కు సరిపోవు
402INSUFFICIENT_BALANCESMS ప్రచారానికి సంబంధించినది, ఖాతా కోసం చెల్లించే వాలెట్ ఖాళీగా ఉంది
422TEMPLATE_NOT_REGISTEREDవచనం లేదా templateId ఖాతాకు అనుమతించిన ఏ టెంప్లేట్‌కీ, లేదా senderId కింద ఏ టెంప్లేట్‌కీ సరిపోదు
422SENDER_NOT_ALLOWEDsenderId ఖాతాకు అనుమతించిన ఏ టెంప్లేట్ హెడరూ కాదు
422MESSAGE_TYPE_NOT_ENABLEDటెంప్లేట్ రకాన్ని Oblic పంపదు: పంపే రకాలు ఖాతా messageTypes; డిఫాల్ట్‌గా service_implicit మాత్రమే
422URL_NOT_WHITELISTEDవేరియబుల్‌లో DLT అనుమతి జాబితాలో లేని డొమైన్ లింక్ ఉంది
422OUTSIDE_PROMOTIONAL_HOURSభారత కాలమానం 10:00 నుంచి 21:00 వెలుపల ప్రచార SMS; Retry-After మళ్లీ ప్రయత్నించే సమయం చెబుతుంది
429RATE_LIMITEDఖాతా గంట పరిమితి దాటింది (డిఫాల్ట్ 1,000 సందేశాలు), లేదా ఒక నంబర్ పరిమితి దాటింది (డిఫాల్ట్ గంటకు 10); Retry-After మళ్లీ ప్రయత్నించే సమయం చెబుతుంది
429QUOTA_EXCEEDEDఖాతా నెలవారీ సెగ్మెంట్ల పరిమితి దాటింది (డిఫాల్ట్ 10,000); Retry-After మళ్లీ ప్రయత్నించే సమయం చెబుతుంది
503SMS_UNAVAILABLESMSను ఇప్పుడు క్యూలో పెట్టలేకపోయింది; అదే Idempotency-Keyతో మళ్లీ ప్రయత్నించండి; లేదా ఈ Oblicలో SMS ఏర్పాటు కాలేదు

GET /external/v1/sms/account ఖాతా పరిమితులు, Oblic పంపే టెంప్లేట్ రకాలు, ఈ నెల పంపిన వినియోగం చూపుతుంది.


POST/external/v1/messages/whatsapp

WhatsApp సందేశం పంపడం

WhatsApp సందేశం ఖాతాకు అనుసంధానించిన నంబర్ నుంచి వెళ్తుంది: అనుమతించిన టెంప్లేట్ లేదా వ్యక్తి చివరి సందేశం తర్వాత 24 గంటల్లో మీ సొంత స్వేచ్ఛా ప్రత్యుత్తరం.

  • పేరు
    to
    టైప్ చేయండి
    string
    వివరణ

    తప్పనిసరి: +919812345678 వంటి అంతర్జాతీయ రూపంలోని నంబర్.

  • పేరు
    template
    టైప్ చేయండి
    string
    వివరణ

    మీ WhatsApp టెంప్లేట్లలో ఒకదాని సృష్టించినప్పటి పేరు. template లేదా text ఇవ్వండి; రెండూ కాదు.

  • పేరు
    language
    టైప్ చేయండి
    string
    వివరణ

    en లేదా hi వంటి టెంప్లేట్ భాష; డిఫాల్ట్ en.

  • పేరు
    variables
    టైప్ చేయండి
    string[]
    వివరణ

    టెంప్లేట్‌లోని {{1}}, {{2}} తదితరాలకు క్రమంలో విలువలు: గరిష్ఠంగా 30, ప్రతి విలువ గరిష్ఠంగా 1,024 అక్షరాలు.

  • పేరు
    headerVariables
    టైప్ చేయండి
    string[]
    వివరణ

    టెంప్లేట్ టెక్స్ట్ హెడర్ వేరియబుల్స్‌కు క్రమంలో విలువలు: గరిష్ఠంగా 5, ప్రతి విలువ గరిష్ఠంగా 1,024 అక్షరాలు.

  • పేరు
    headerMediaUrl
    టైప్ చేయండి
    string
    వివరణ

    టెంప్లేట్ హెడర్ పంపే చిత్రం, వీడియో లేదా పత్రం https లింక్, గరిష్ఠంగా 2,048 అక్షరాలు. ఇవ్వకపోతే టెంప్లేట్ అనుమతించినప్పటి మీడియాను పంపుతుంది.

  • పేరు
    text
    టైప్ చేయండి
    string
    వివరణ

    మీ సొంత స్వేచ్ఛా ప్రత్యుత్తరం, గరిష్ఠంగా 4,096 అక్షరాలు; మీ నంబర్‌కు వ్యక్తి చివరి సందేశం తర్వాత 24 గంటల్లో మాత్రమే పంపవచ్చు.

  • పేరు
    metadata
    టైప్ చేయండి
    object
    వివరణ

    ఆర్డర్ లేదా టెనెంట్ ID వంటి కీ ఆధారిత మీ సొంత స్ట్రింగ్‌లు, సందేశం మరియు దాని ప్రతి వెబ్‌హుక్‌తో తిరిగి వస్తాయి; స్వీకర్తలకు పంపబడవు. మెటాడేటా చూడండి.

ఒక WhatsApp టెంప్లేట్

curl -X POST https://api.oblic.app/external/v1/messages/whatsapp \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "to": "+919812345678",
    "template": "order_shipped",
    "language": "en",
    "variables": ["Asha", "1042"]
  }'

టెంప్లేట్ హెడర్ దాని ప్రధాన భాగంలాగే నింపబడుతుంది. headerVariables టెక్స్ట్ హెడర్ వేరియబుల్స్‌ను నింపుతుంది; headerMediaUrl మీడియా హెడర్‌కు చిత్రం, వీడియో లేదా పత్రాన్ని ఇస్తుంది; లేకపోతే అనుమతించినప్పటి మీడియా వెళ్తుంది. స్థానం హెడర్, సొంత విలువ ఉన్న బటన్ లేదా {{first_name}} వంటి పేరున్న వేరియబుల్ వంటి API పంపలేని అంశాలు కావాల్సిన టెంప్లేట్, పంపడం లేదా చార్జ్ చేయడానికి ముందే తిరస్కరించబడుతుంది.

చిత్ర హెడర్ ఉన్న టెంప్లేట్

curl -X POST https://api.oblic.app/external/v1/messages/whatsapp \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "to": "+919812345678",
    "template": "diwali_sale",
    "headerMediaUrl": "https://cdn.example.com/diwali.jpg",
    "variables": ["20%"]
  }'

GET /external/v1/whatsapp/recipients/{number} నంబర్ మార్కెటింగ్‌ను నిరాకరించిందా, స్వేచ్ఛా ప్రత్యుత్తరాన్ని ఎప్పటి వరకు పంపవచ్చో తెలియజేస్తుంది.

తిరస్కరణcdఎప్పుడు
400INVALID_REQUESTtemplate, text రెండూ లేవు లేదా రెండూ ఉన్నాయి; లేదా headerVariables లేదా headerMediaUrlను textతో ఇచ్చారు
402INSUFFICIENT_BALANCEమార్కెటింగ్ టెంప్లేట్, ఖాతా కోసం చెల్లించే వాలెట్ ఖాళీగా ఉంది
422INVALID_NUMBERto అంతర్జాతీయ రూపంలోని నంబర్ కాదు
422WHATSAPP_NOT_CONNECTEDఖాతాకు అనుసంధానించిన WhatsApp నంబర్ లేదు
422TEMPLATE_NOT_FOUNDఆ పేరుతో ఆ భాషలో టెంప్లేట్ ఖాతాలో లేదు
422TEMPLATE_NOT_APPROVEDMeta టెంప్లేట్‌ను అనుమతించలేదు
422INVALID_VARIABLESవేరియబుల్స్ సంఖ్య టెంప్లేట్ ప్రధాన భాగం లేదా టెక్స్ట్ హెడర్‌తో సరిపోదు; లేదా మీడియా హెడర్‌కు headerVariables, మీడియా కాని హెడర్‌కు headerMediaUrl ఇచ్చారు
422MEDIA_REQUIREDటెంప్లేట్ హెడర్ చిత్రం, వీడియో లేదా పత్రం, కానీ headerMediaUrl https లింక్ కాదు; లేదా ఇవ్వకపోతే అనుమతించినప్పటి మీడియా లింక్ కూడా https కాదు
422TEMPLATE_NOT_SENDABLEటెంప్లేట్ API పంపలేని అంశాలను కోరుతుంది: స్థానం హెడర్, సొంత విలువ ఉన్న బటన్ లేదా పేరున్న వేరియబుల్
422RECIPIENT_OPTED_OUTమార్కెటింగ్‌ను నిరాకరించిన నంబర్‌కు మార్కెటింగ్ టెంప్లేట్
422OUTSIDE_SESSION_WINDOWవ్యక్తి చివరి సందేశం తర్వాత 24 గంటలు దాటి స్వేచ్ఛా ప్రత్యుత్తరం

పంపడాన్ని మళ్లీ ప్రయత్నించడం

ప్రతి పంపకంతో Idempotency-Key హెడర్ ఇవ్వండి; ఆర్డర్ లేదా ఈవెంట్ ID వంటి మీ ఇష్టమైన 1 నుంచి 255 అక్షరాలు. సమయం ముగిసినా లేదా స్వీకరించిందో తెలియకపోయినా అదే కీ, అదే ప్రధాన భాగంతో మళ్లీ పంపండి. నకలు నివారణ నిల్వ చేసిన కీ స్థితిపై ఆధారపడుతుంది; అన్ని పునరావృత అభ్యర్థనలపై శాశ్వత హామీ కాదు:

  • అదే పంపకాన్ని మళ్లీ చేస్తే మొదటి సందేశం IDతో 202 వస్తుంది; ఏదీ రెండుసార్లు పంపబడదు.
  • అదే కీతో వేరే సందేశం, దాని metadataతో సహా, 409 IDEMPOTENCY_CONFLICTతో తిరస్కరించబడుతుంది; ఏదీ క్యూలో చేరదు.
  • కీ ఎంతకాలం ఉంటుంది: ఇమెయిల్, WhatsApp కీ స్థితి Redisలో 24 గంటలు నిల్వ ఉంటుంది; క్యాష్ పోయినా లేదా గడువు ముగిసినా నకలు నివారణ స్థితి పోతుంది, అదే కీ మళ్లీ పంపవచ్చు. నిల్వ చేసిన సందేశ రికార్డులో SMS కీకి సమయాధారిత గడువు లేదు: తర్వాతి SMSకి ప్రత్యేక కీ అవసరం. ఈ పరిమితులు డెలివరీకి హామీ కావు.
  • కీలు మీ సంస్థకు చెందినవి, ప్రతి ఛానల్‌కు ఒక సమితి; అందువల్ల ఒకే కీని ఇమెయిల్, SMSకి ఉపయోగించవచ్చు. X-Oblic-On-Behalf-Of కింద అవి ఉపఖాతాకు చెందినవి.
  • మళ్లీ ప్రయత్నించడాన్ని తిరిగి తనిఖీ చేస్తుంది, సరిపోల్చడానికి ముందు: పంపేవారు ఇక ధృవీకరించబడని ఇమెయిల్ లేదా 24 గంటలు దాటిన WhatsApp ప్రత్యుత్తరం మొదటి ID ఇవ్వకుండా తిరస్కరించబడుతుంది.

ఖాళీ కీ లేదా 255 అక్షరాల కంటే పొడవైన కీ 400 INVALID_IDEMPOTENCY_KEY ఇస్తుంది.

ఇమెయిల్‌లో ఖాళీ కాని cc, bcc జాబితాలు ఐడెంపోటెన్సీ హాష్‌లో భాగం, వాటి చిరునామాలు to లో కూడా ఉన్నా సరే. లేని లేదా ఖాళీ జాబితాలు To మాత్రమే ఉన్న అభ్యర్థన హాష్ నిర్మాణాన్ని మార్చవు; పైన పేర్కొన్న కీ నిలుపుదల, అర్హత పరిమితులు వర్తిస్తూనే ఉంటాయి.


మెటాడేటా

ఏ పంపకానికైనా metadata, కీ ఆధారిత మీ సొంత స్ట్రింగ్‌లు ఇవ్వండి, అప్పుడు మీ రికార్డుల్లో ఆర్డర్, టెనెంట్ లేదా ప్రచారం ద్వారా సందేశాన్ని కనుగొనవచ్చు. Oblic మెటాడేటాను నిల్వ చేసి సందేశ ప్రతిస్పందనల్లో, వెబ్‌హుక్‌లలో ఇస్తుంది; కానీ డెలివరీ కోసం అర్థం చేసుకోదు, స్వీకర్తలు లేదా ప్రదాతలకు పంపదు. రహస్యాలు లేదా సున్నితమైన విలువలను దాచదు: ఇచ్చే వాటిని తనిఖీ చేయండి; అనుమతించిన కీ పేరు గోప్యతా ఫిల్టర్ కాదు.

మెటాడేటాతో SMS

{
  "to": "+919876543210",
  "text": "Your order 1042 has shipped.",
  "metadata": { "orderId": "1042", "tenant": "acme" }
}
  • గరిష్ఠంగా 20 కీలు, ప్రతి కీ 1 నుంచి 40 ASCII అక్షరాలు, అంకెలు, _, . లేదా -తో ఉండాలి; ప్రతి విలువ గరిష్ఠంగా 500 అక్షరాల స్ట్రింగ్. సంఖ్య లేదా true రాసినట్లుగానే "1042" లేదా "true" స్ట్రింగ్‌గా నిల్వ ఉంటుంది; null లేదా ఆబ్జెక్ట్ 400తో తిరస్కరించబడుతుంది; ఏదీ క్యూలో చేరదు.
  • ఇది తిరిగి వస్తుంది సందేశం పొందడంలో, సందేశాల జాబితాలో ప్రతి నమోదులో, data.metadataగా సందేశం ప్రతి వెబ్‌హుక్లో: అది లేకుండా పంపితే {}.
  • సందేశంలో భాగం: అదే Idempotency-Keyతో వేరే మెటాడేటా అంటే వేరే సందేశం; 409 IDEMPOTENCY_CONFLICT వస్తుంది.

GET/external/v1/messages

సందేశాల జాబితా

API ద్వారా పంపిన సందేశాలు, కొత్తవి ముందు, ప్రతి స్వీకర్తకు ఒక నమోదు: మూడు చిరునామాలకు ఇమెయిల్ అంటే ఒకే id ఉన్న మూడు నమోదులు.

  • పేరు
    channel
    టైప్ చేయండి
    string
    వివరణ

    email, sms లేదా whatsapp; పలు విలువలకు పరామితిని మళ్లీ ఇవ్వండి.

  • పేరు
    status
    టైప్ చేయండి
    string
    వివరణ

    queued, sent, delivered, read, bounced, skipped లేదా failed; పలు విలువలకు పరామితిని మళ్లీ ఇవ్వండి.

  • పేరు
    since
    టైప్ చేయండి
    string
    వివరణ

    అభ్యర్థించిన తొలి సమయం, సరిహద్దుతో సహా, ISO 8601లో Z లేదా స్పష్టమైన UTC ఆఫ్‌సెట్‌తో, ఉదాహరణకు 2026-10-01T00:00:00Z. ఆఫ్‌సెట్ లేని స్థానిక సమయం ఒక నిర్దిష్ట క్షణం కాదు.

  • పేరు
    until
    టైప్ చేయండి
    string
    వివరణ

    అభ్యర్థించిన చివరి సమయం, సరిహద్దు మినహా, దీనికీ Z లేదా స్పష్టమైన UTC ఆఫ్‌సెట్ అవసరం.

  • పేరు
    limit
    టైప్ చేయండి
    integer
    వివరణ

    ఎన్ని, 1 నుంచి 100; డిఫాల్ట్ 25.

  • పేరు
    cursor
    టైప్ చేయండి
    string
    వివరణ

    తర్వాతి పేజీ చదవడానికి గత పేజీ next. పేజినేషన్ చూడండి.

ఈ వారం దాటవేసిన ఇమెయిళ్లు

curl -G https://api.oblic.app/external/v1/messages \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d channel=email \
  -d status=skipped \
  -d since=2026-10-19T00:00:00Z

ప్రతిస్పందన

{
  "status": "success",
  "data": {
    "messages": [
      {
        "id": "msg_4f9c2a1e8b7d4c3f9e0a1b2c3d4e5f60",
        "channel": "email",
        "to": "ravi@example.org",
        "status": "skipped",
        "reason": "unsubscribed",
        "requestedAt": "2026-10-20T08:15:02.120Z",
        "sentAt": null,
        "deliveredAt": null,
        "readAt": null,
        "failedAt": null,
        "openedAt": null,
        "clickedAt": null,
        "metadata": { "orderId": "1042" }
      }
    ],
    "next": null
  },
  "errors": null
}
  • status అన్ని ఛానళ్లకు ఒకే సమితి: queued (ఇంకా పంపలేదు), sent (ప్రదాత స్వీకరించింది), delivered, read, bounced, skipped (పంపలేదు, ఉదాహరణకు చందా రద్దు లేదా నిరోధించిన చిరునామా), failed. reason కారణం చెబుతుంది; దాటవేసినప్పుడు unsubscribed లేదా suppressed వంటివి.
  • to ఇమెయిల్ చిరునామా, +91 ఉన్న SMS నంబర్ లేదా + లేని WhatsApp నంబర్ అంకెలు.
  • సమయాలు ప్రతి సంఘటన ఎప్పుడు జరిగిందో తెలుపుతాయి లేదా null; openedAt, clickedAt ఇమెయిల్‌కు చెందినవి.
  • metadata పంపినప్పుడు ఇచ్చిన విలువలు లేదా {}.

GET/external/v1/messages/{messageId}

సందేశం పొందడం

పంపినప్పుడు ఇచ్చిన ID ద్వారా ఒక సందేశం, దాని ఫలితం. SMS, WhatsApp ప్రతిస్పందనలు దగ్గర రూపంలో ఉంటాయి: SMSలో segments, WhatsAppలో readAt; ఇమెయిల్‌కు ప్రత్యేక రూపంలో ఈవెంట్లు వచ్చేకొద్దీ ప్రతి స్వీకర్త నమోదు ఉంటుంది.

ఒక SMS సందేశం

{
  "status": "success",
  "data": {
    "id": "msg_9a1b2c3d4e5f60718293a4b5c6d7e8f9",
    "channel": "sms",
    "status": "delivered",
    "segments": 1,
    "sentAt": "2026-10-20T08:15:03.410Z",
    "deliveredAt": "2026-10-20T08:15:06.902Z",
    "failedAt": null,
    "failureCode": null,
    "metadata": { "orderId": "1042" }
  },
  "errors": null
}

ఒక ఇమెయిల్

{
  "status": "success",
  "data": {
    "id": "msg_4f9c2a1e8b7d4c3f9e0a1b2c3d4e5f60",
    "status": "sent",
    "recipients": [
      {
        "email": "asha@example.org",
        "deliveredAt": "2026-10-20T08:16:11Z",
        "openedAt": "2026-10-20T09:02:40Z",
        "bouncedAt": null,
        "complainedAt": null,
        "delayedAt": null
      }
    ],
    "metadata": {}
  },
  "errors": null
}
  • SMS status queued, sent, delivered, undelivered లేదా failed.
  • WhatsApp సందేశ స్థితి queued, sent, delivered, read లేదా failed, అలాగే readAt. దాని failureCode Metaది, ఉదాహరణకు meta:131026.
  • ఇమెయిల్ స్థితి పంపేవరకు queued, తర్వాత sent, కొందరు స్వీకర్తలు దాటవేస్తే partially_suppressed, అందరినీ దాటవేస్తే suppressed, పంపలేకపోతే failed. ప్రతి స్వీకర్త సమయాలు ఇమెయిల్ ప్రదాత ఈవెంట్ల నుంచి వస్తాయి; మొదటి ఈవెంట్ వరకు recipients ఖాళీగా ఉంటుంది.
  • metadata పంపినప్పుడు ఇచ్చిన విలువలు లేదా {}: మెటాడేటా చూడండి.

ఖాతాకు చెందని లేదా లేని సందేశం 404 MESSAGE_NOT_FOUND ఇస్తుంది. ఎన్నడూ పంపని ఇమెయిల్ ఇక్కడ 24 గంటల తర్వాత దొరకదు; జాబితాలో మాత్రం ఉంటుంది.


GET/external/v1/reports/summary

నివేదిక సారాంశం

ఒక వ్యవధిలో పంపాలని అభ్యర్థించిన సందేశాల ఫలితాలు, ఛానల్, స్థితి ప్రకారం లెక్కలు; అలాగే ఎన్ని ఇమెయిళ్లు తెరిచారు, క్లిక్ చేశారు లేదా స్పామ్‌గా గుర్తించారు అనే సంఖ్యలు.

  • పేరు
    from
    టైప్ చేయండి
    string
    వివరణ

    వ్యవధి ప్రారంభం, సరిహద్దుతో సహా, ISO 8601లో Z లేదా స్పష్టమైన UTC ఆఫ్‌సెట్‌తో; డిఫాల్ట్ toకు 30 రోజుల ముందు.

  • పేరు
    to
    టైప్ చేయండి
    string
    వివరణ

    వ్యవధి ముగింపు, సరిహద్దు మినహా, దీనికీ Z లేదా స్పష్టమైన UTC ఆఫ్‌సెట్ అవసరం; డిఫాల్ట్ ఇప్పుడు. ఇది from తర్వాత ఉండాలి; మధ్య తేడా గరిష్ఠంగా 92 రోజులు.

ప్రతిస్పందన

{
  "status": "success",
  "data": {
    "from": "2026-09-24T00:00:00Z",
    "to": "2026-10-24T00:00:00Z",
    "all": {
      "messages": 1250,
      "statuses": { "queued": 4, "sent": 96, "delivered": 1075, "read": 30, "bounced": 12, "skipped": 18, "failed": 15 },
      "opened": 410,
      "clicked": 96,
      "complained": 1
    },
    "channels": {
      "email": { "messages": 800, "statuses": { "queued": 2, "sent": 40, "delivered": 728, "read": 0, "bounced": 12, "skipped": 18, "failed": 0 }, "opened": 410, "clicked": 96, "complained": 1 },
      "sms": { "messages": 300, "statuses": { "queued": 1, "sent": 36, "delivered": 253, "read": 0, "bounced": 0, "skipped": 0, "failed": 10 }, "opened": 0, "clicked": 0, "complained": 0 },
      "whatsapp": { "messages": 150, "statuses": { "queued": 1, "sent": 20, "delivered": 94, "read": 30, "bounced": 0, "skipped": 0, "failed": 5 }, "opened": 0, "clicked": 0, "complained": 0 }
    }
  },
  "errors": null
}

ప్రతి ఛానల్, స్థితి ఎప్పుడూ ఉంటుంది; జాబితాలోని అదే పదాలతో లెక్కిస్తారు. from అనేది toకు సమానం లేదా తర్వాత ఉంటే, లేదా తేడా 92 రోజులకు మించితే 400 INVALID_PERIOD వస్తుంది.

ఈ పేజీ సహాయకరంగా ఉందా?