Oblic

ఉపఖాతాలు

తన వినియోగదారుల తరఫున సందేశాలు పంపే వేదిక ఒక్కొక్కరికీ ఉపఖాతాను ఇస్తుంది: సొంత పంపినవారి గుర్తింపులు, టెంప్లేట్‌లు, సందేశాలు, నివేదికలు కలిగిన ప్రత్యేక Oblic సంస్థ. దాన్ని పేర్కొని మీ కీ దాని తరఫున పనిచేస్తుంది. ఉపఖాతాలను నిర్వహించడానికి accounts:manage ఉన్న Owner లేదా Admin కీ అవసరం.


POST/external/v1/accounts

ఉపఖాతాను సృష్టించడం

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

    తప్పనిసరి: వినియోగదారుని పేరు, గరిష్ఠంగా 511 అక్షరాలు.

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

    తప్పనిసరి: మీ వ్యవస్థలో వినియోగదారుని గుర్తింపు, గరిష్ఠంగా 100 ASCII అక్షరాలు, అంకెలు మరియు _, ., :, - గుర్తులు. తరువాత ఉపఖాతాను పేర్కొనడానికి దీన్ని వాడండి.

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

    ఉపఖాతాకు సొంత API కీ ఇవ్వాలా అనేది; అప్రమేయ విలువ true.

ఉపఖాతాను సృష్టించడం

curl -X POST https://api.oblic.app/external/v1/accounts \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Asha Textiles", "externalId": "tenant-4821" }'

ప్రతిస్పందన

{
  "status": "success",
  "data": {
    "id": "ORG000R7ZM4Q2VXH00",
    "name": "Asha Textiles",
    "externalId": "tenant-4821",
    "active": true,
    "createdAt": "2026-10-24T09:30:00Z",
    "apiKey": "obl_live_…"
  },
  "errors": null
}
  • apiKey ఈ ప్రతిస్పందనలో మాత్రమే కనిపిస్తుంది: అప్పుడే భద్రపరచండి లేదా మరొక కీ కోసం ఉపఖాతాను మళ్లీ సృష్టించండి. ఇది పాత అప్రమేయ అనుమతులు ఉన్న User కీ; వాటిలో events:write ఉండదు. పంపడం, చదవడం, గుర్తింపులు మరియు పరిచయాల జాబితాలను నిర్వహించడం సాధ్యం, కానీ Owner లేదా Admin కీ అవసరమైన మార్గాలను పిలవలేరు.
  • అదే externalId మళ్లీ పంపితే అదే ఉపఖాతా వస్తుంది; నిష్క్రియంగా ఉంటే మళ్లీ క్రియాశీలమవుతుంది, పేరు మారదు. issueKey విలువ false కాకపోతే ప్రతి పిలుపు మరో కీని ఇస్తుంది. నిష్క్రియం చేసినప్పుడు రద్దయినవి తప్ప పాత కీలు పనిచేస్తూనే ఉంటాయి.
  • ఉపఖాతాకు సొంత ఉపఖాతాలు ఉండవు: ఉపఖాతా తరఫున పనిచేస్తూ మరొకటి సృష్టిస్తే 403 SUB_ACCOUNT_NOT_ALLOWED వస్తుంది.

GET/external/v1/accounts

ఉపఖాతాల జాబితా చూడడం

సృష్టించిన క్రమంలో అన్ని ఉపఖాతాలూ వస్తాయి; active విలువ false ఉన్న నిష్క్రియ ఖాతాలూ ఉంటాయి. జాబితాలో కీలు ఎప్పుడూ ఉండవు.


DELETE/external/v1/accounts/{accountId}

ఉపఖాతాను నిష్క్రియం చేయడం

Oblic యొక్క id ద్వారా ఉపఖాతాను నిష్క్రియం చేస్తుంది, మీ externalId ద్వారా కాదు; దాని కీలన్నింటినీ వెంటనే రద్దు చేస్తుంది. అదే externalId తో మళ్లీ సృష్టిస్తే క్రియాశీలమవుతుంది. సంస్థకు చెందని ఉపఖాతాకు 404 ACCOUNT_NOT_FOUND వస్తుంది.


ఉపఖాతా తరఫున పనిచేయడం

X-Oblic-On-Behalf-Of లో ఉపఖాతా externalId పంపండి. దాని సొంత కీని వాడినట్లే అభ్యర్థన దాని తరఫున నడుస్తుంది. మీ ఒకే కీ అందరు వినియోగదారులకూ సరిపోతుంది; ఒక్కొక్కరికీ ప్రత్యేక కీ ఉంచాల్సిన అవసరం లేదు.

వినియోగదారుని ఖాతా నుంచి పంపడం

curl -X POST https://api.oblic.app/external/v1/messages/email \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'X-Oblic-On-Behalf-Of: tenant-4821' \
  -H 'Content-Type: application/json' \
  -d '{ "from": "hello@ashatextiles.example", "to": ["asha@example.org"], "subject": "Welcome", "html": "<p>Welcome!</p>" }'
  • ఉపఖాతాకు సొంతమైనవి: ఇమెయిల్ దాని సొంత గుర్తింపుల నుంచి మాత్రమే వెళుతుంది; సందేశాలు, నివేదికలు, టెంప్లేట్‌లు, వెబ్‌హుక్‌లు మరియు Idempotency-Key విలువలూ దానికి ప్రత్యేకంగా ఉంటాయి.
  • మీ సంస్థకు చెందినవి: దాని సందేశాలకు మీ సంస్థ వాలెట్ చెల్లిస్తుంది; దాని తరఫున చేసే అభ్యర్థనలకు మీ అనుమతించిన IP జాబితా వర్తిస్తుంది.
  • మీ కీ పాత్రే వర్తిస్తుంది, కాబట్టి వినియోగదారుని టెంప్లేట్‌లు, వెబ్‌హుక్‌లు లేదా WhatsApp నంబరును మీ Owner లేదా Admin కీ మరియు హెడర్‌తో నిర్వహించండి.
  • క్రియాశీల ఉపఖాతా లేని externalId కు 404 ACCOUNT_NOT_FOUND వస్తుంది.
  • ఉపఖాతా వెబ్‌హుక్ ఈవెంట్‌లు దానికి సొంత ఎండ్‌పాయింట్‌లు ఉంటే వాటికే, లేకపోతే మీ ఎండ్‌పాయింట్‌లకు వెళతాయి. దాని externalId ప్రతి ఈవెంట్ account లో ఉంటుంది. వెబ్‌హుక్‌లు చూడండి.
  • ఉపఖాతా పంపే SMS టెంప్లేట్‌లు మీరు దానితో పంచుకున్నవే. టెంప్లేట్‌లు చూడండి.
ఈ పేజీ సహాయకరంగా ఉందా?