టెంప్లేట్లు
ఖాతా పంపడానికి వాడే టెంప్లేట్లను నిర్వహించండి: ఈమెయిల్ టెంప్లేట్లు, SMS హెడర్లు మరియు DLT టెంప్లేట్లు, WhatsApp నంబరు మరియు టెంప్లేట్లు. చదవడానికి ఛానల్ పంపే స్కోప్ లేదా templates:manage అవసరం; మార్పులకు templates:manage ఉన్న Owner లేదా Admin కీ అవసరం.
ఈ /external/v1 మార్గాలు API కీలను వాడతాయి. OAuth యాక్సెస్ టోకెన్లు API v2 వాడతాయి; ఉదాహరణ ఉండటం వల్ల ఒక డిప్లాయ్మెంట్ ఆ వెర్షన్ కోసం కాన్ఫిగర్ అయిందని నిరూపితం కాదు.
ఈమెయిల్ టెంప్లేట్లు
ఖాతా ఈమెయిల్ టెంప్లేట్లు దాని డిఫాల్ట్ వర్క్స్పేస్కు చెందినవి; API సందేశాలు అక్కడే ఉంటాయి, డ్యాష్బోర్డ్ కూడా అక్కడే వాటిని చూపుతుంది. API ద్వారా సృష్టించిన టెంప్లేట్ HTML, దానిలోని {{name}} ప్లేస్హోల్డర్లను పంపేటప్పుడు నింపుతారు. డ్యాష్బోర్డ్ ఎడిటర్లో రూపొందించిన టెంప్లేట్ను చదవవచ్చు, పంపడానికి వాడవచ్చు, తొలగించవచ్చు; HTML మరియు రూపకల్పన విడిపోకుండా దాన్ని భర్తీ చేయలేరు.
| పద్ధతి | మార్గం | పని |
|---|---|---|
GET | /external/v1/templates | కొత్తవి ముందుగా ఉండే టెంప్లేట్లు, వాటి HTML లేకుండా |
GET | /external/v1/templates/{id} | ఒక టెంప్లేట్, దాని HTML మరియు అంగీకరించే వేరియబుల్లతో |
POST | /external/v1/templates | HTML నుంచి టెంప్లేట్ సృష్టిస్తుంది: 201 |
PUT | /external/v1/templates/{id} | HTML నుంచి సృష్టించిన టెంప్లేట్ పేరు, విషయం మరియు HTML ను భర్తీ చేస్తుంది |
DELETE | /external/v1/templates/{id} | టెంప్లేట్ తొలగిస్తుంది: 204; తరువాత జాబితాలో ఉండదు లేదా పంపడానికి వాడలేరు |
- పేరు
name- టైప్ చేయండి
- string
- వివరణ
తప్పనిసరి: టెంప్లేట్ పేరు, గరిష్ఠంగా 255 అక్షరాలు. Oblic ప్రామాణిక పేరు తనిఖీ కూడా వర్తిస్తుంది; పొడవు మాత్రమే సరిగ్గా ఉంటే సరిపోదు.
- పేరు
subject- టైప్ చేయండి
- string
- వివరణ
పంపే అభ్యర్థనలో విషయం ఇవ్వనప్పుడు ఈ టెంప్లేట్ ఈమెయిల్ వాడే విషయం, గరిష్ఠంగా 1,023 అక్షరాలు, సొంత ప్లేస్హోల్డర్లతో. ఇవ్వని లేదా ఖాళీ విషయాన్ని
nullగా నిల్వ చేస్తారు; ఖాళీ కాని విషయం ముందు, వెనుక ఖాళీలు తొలగిస్తారు.
- పేరు
html- టైప్ చేయండి
- string
- వివరణ
తప్పనిసరి: HTML, ఇచ్చినట్లుగానే నిల్వ అవుతుంది, గరిష్ఠంగా 65,535 UTF-8 బైట్లు. పంపేటప్పుడు ప్లేస్హోల్డర్లను నింపే వేరియబుల్ విలువలను HTML-escape చేస్తారు; దీనివల్ల టెంప్లేట్ HTML శుద్ధి కాదు లేదా sandbox లో వేరుచేయబడదు.
టెంప్లేట్ సృష్టించడం
curl -X POST https://api.oblic.app/external/v1/templates \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"name": "Order shipped",
"subject": "Order {{order_id}} is on its way",
"html": "<p>Hi {{first_name}}, your order {{order_id}} has shipped.</p>"
}'
201 సృష్టించబడింది
{
"status": "success",
"data": {
"id": "TEM000R7ZM4Q2VXH00",
"name": "Order shipped",
"subject": "Order {{order_id}} is on its way",
"kind": "html",
"variables": ["order_id", "first_name"],
"html": "<p>Hi {{first_name}}, your order {{order_id}} has shipped.</p>",
"createdAt": "2026-10-24T09:30:00Z",
"updatedAt": "2026-10-24T09:30:00Z"
},
"errors": null
}
- ప్లేస్హోల్డర్
{{name}}: ASCII అక్షరాలు మరియు అంకెలు,_,.,-, పేరు లోపల మాత్రమే ఖాళీలు, గరిష్ఠంగా 64 అక్షరాలు.variablesవిషయం మరియు HTML లోని వాటిని పెద్ద-చిన్న అక్షరాల భేదం లేకుండా, మొదట కనిపించిన క్రమం, వ్రాతతో జాబితా చేస్తుంది. kindAPI ద్వారా చేసిన టెంప్లేట్కుhtml, డ్యాష్బోర్డ్ ఎడిటర్లో చేసినదానికిdesigned. విషయం లేకపోతే పంపేటప్పుడు ఇవ్వండి; దాని రకం తిరిగి వచ్చిన విషయాన్ని తనిఖీ చేయడానికి ప్రత్యామ్నాయం కాదు.- డ్యాష్బోర్డ్ ప్రస్తావనలు, ఉదాహరణకు
@unsubscribeలేదా@organizationName, ప్రచారాలు, ఆటోమేషన్లు మాత్రమే ప్రతి స్వీకర్త కోసం నింపుతాయి. అలాంటి ప్రస్తావన ఉన్న టెంప్లేట్తో పంపడం తిరస్కరించబడుతుంది. - జాబితా
cursor,limitతో పేజీలుగా విభజించబడుతుంది: డిఫాల్ట్గా పేజీకి 25, పరిధి 1 నుంచి 100, పేజీ విభజన వివరించినట్లు. తిరిగి వచ్చిన కర్సర్ను అంతర్గత రూపం అర్థం చేసుకోని అపారదర్శక విలువగా చూడండి.
| తిరస్కరణ | cd | ఎప్పుడు |
|---|---|---|
| 400 | TEMPLATE_TOO_LARGE | HTML 65,535 బైట్లను మించింది |
| 404 | TEMPLATE_NOT_FOUND | ఖాతాలో ఆ ID తో టెంప్లేట్ లేదు |
| 409 | TEMPLATE_DESIGNED | డ్యాష్బోర్డ్ ఎడిటర్లో రూపొందించిన టెంప్లేట్ భర్తీ చేయడం |
SMS హెడర్లు మరియు టెంప్లేట్లు
SMS ఒక DLT హెడర్ నుంచి వెళ్లి Cunomial కాన్ఫిగర్ చేసిన DLT సంస్థ కింద ఉన్న కంటెంట్ టెంప్లేట్తో సరిపోతుంది. రెండింటినీ ముందుగా DLT ప్లాట్ఫామ్లో నమోదు చేసి, SMS పంపడంతో సరిపోల్చడానికి ఇక్కడ రికార్డు చేస్తారు. ఇక్కడ రికార్డు చేయడం DLT నమోదు చేయదు. SMS ఖాతా సమాధానంలో keepsRegistry, available కాన్ఫిగర్ చేసిన రిజిస్ట్రీ అనుమతి, అందుబాటును వివరిస్తాయి, డెలివరీ హామీ కాదు.
రిజిస్ట్రీలో ఆమోదించిన టెంప్లేట్లు మాత్రమే జాబితాలో ఉంటాయి; నిష్క్రియ ఆమోదిత టెంప్లేట్లు కూడా కనిపించవచ్చు. పంపడానికి క్రియాశీల టెంప్లేట్, సందేశాలు వివరించే ఇతర పంపే తనిఖీలు కూడా అవసరం.
| పద్ధతి | మార్గం | పని |
|---|---|---|
GET | /external/v1/sms/account | ఖాతా పరిమితులు, ఈ నెలలో పంపినవి, అనుమతించిన సందేశ రకాలు |
GET | /external/v1/sms/senders | ఖాతా సొంత హెడర్లు, [{"senderId": …, "isDefault": …}] |
PUT | /external/v1/sms/senders/{senderId} | ఆరు అక్షరాలు లేదా ఆరు అంకెల హెడర్ జోడిస్తుంది; {"isDefault": true} దాన్ని డిఫాల్ట్ చేస్తుంది |
DELETE | /external/v1/sms/senders/{senderId} | ఏ టెంప్లేట్ వాడని హెడర్ను తొలగిస్తుంది: 204 |
GET | /external/v1/sms/templates | ఖాతా టెంప్లేట్లు, తరువాత మాతృ ఖాతా పంచుకున్నవి |
POST | /external/v1/sms/templates | టెంప్లేట్ జోడిస్తుంది: 201 |
PUT | /external/v1/sms/templates/{id} | పూర్తిగా ఇచ్చిన టెంప్లేట్ను మారుస్తుంది |
DELETE | /external/v1/sms/templates/{id} | టెంప్లేట్ తొలగిస్తుంది: 204 |
PUT | /external/v1/sms/templates/{id}/sharing | ఏవీ కాదు, అన్ని లేదా పేర్కొన్న ఉపఖాతాలకు దానితో పంపే అనుమతి ఇస్తుంది |
- పేరు
templateId- టైప్ చేయండి
- string
- వివరణ
తప్పనిసరి: టెంప్లేట్ DLT ID, గరిష్ఠంగా 32 అంకెలు.
- పేరు
senderId- టైప్ చేయండి
- string
- వివరణ
తప్పనిసరి: ఖాతా హెడర్లలో ఒకటి. ప్రచార టెంప్లేట్ ఆరు అంకెల హెడర్, మిగతావి ఆరు అక్షరాల హెడర్ వాడతాయి.
- పేరు
name- టైప్ చేయండి
- string
- వివరణ
తప్పనిసరి: మీరు ఎంచుకున్న పేరు, గరిష్ఠంగా 80 అక్షరాలు.
- పేరు
body- టైప్ చేయండి
- string
- వివరణ
తప్పనిసరి: DLT లో నమోదు చేసిన పాఠ్యం, గరిష్ఠంగా 2,000 అక్షరాలు, ప్రతి వేరియబుల్
{#var#}రూపంలో, గరిష్ఠంగా 30 వేరియబుల్లు.
- పేరు
variableKeys- టైప్ చేయండి
- string[]
- వివరణ
ప్రతి వేరియబుల్కు క్రమంలో పేరు, ఉదాహరణకు
["otp", "minutes"]. ఇవ్వకపోతే లేదా ఖాళీగా ఉంటే1నుంచిnస్థాన పేర్లు వాడతారు. ఇస్తే పేర్లు ప్రత్యేకంగా ఉండి ASCII అక్షరాలు, అంకెలు లేదా_కలిగి, ఒక్కొక్కటి 1 నుంచి 30 అక్షరాలు ఉండాలి; వాటి సంఖ్య వేరియబుల్ల సంఖ్యతో సరిపోవాలి.
- పేరు
type- టైప్ చేయండి
- string
- వివరణ
తప్పనిసరి: DLT రకం,
transactional,service_implicit,service_explicitలేదాpromotional.
- పేరు
unicode- టైప్ చేయండి
- boolean
- వివరణ
పాఠ్యం Unicode అవునా; డిఫాల్ట్
false.
- పేరు
active- టైప్ చేయండి
- boolean
- వివరణ
పంపడానికి అనుమతి ఉందా; డిఫాల్ట్
true.
టెంప్లేట్ జోడించడం
curl -X POST https://api.oblic.app/external/v1/sms/templates \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"templateId": "1107161234567890123",
"senderId": "EXMPLE",
"name": "Sign-in code",
"body": "Your Example code is {#var#}. It is valid for {#var#} minutes.",
"variableKeys": ["code", "minutes"],
"type": "service_implicit"
}'
- Oblic SMS నమోదు చేసే ఖాతాలు మాత్రమే హెడర్లు, టెంప్లేట్లను జోడించి మార్చవచ్చు; ఇతర ఖాతాలకు
403 REGISTRY_NOT_ALLOWEDవస్తుంది, అవి తమతో పంచుకున్న టెంప్లేట్లు వాడతాయి. - పంచుకోవడం
{"scope": "none" | "all" | "selected", "accounts": […]}తీసుకుంటుంది, గరిష్ఠంగా 1,000 ఉపఖాతాexternalIdవిలువలుselectedకోసం. ప్రతి ఖాతా మాతృ ఖాతాకు చెందాలి. ఖాళీ ఎంపిక ఏ ఉపఖాతాతోనూ పంచుకోదు. - హెడర్ డిఫాల్ట్ గుర్తు ప్రతి
PUTలో నిర్ణయిస్తారు:"isDefault": trueలేకుండా హెడర్ డిఫాల్ట్ కాదు. ఒకదాన్ని డిఫాల్ట్ చేస్తే ఖాతా మునుపటి డిఫాల్ట్ నుంచి ఆ గుర్తు తొలగుతుంది.
| తిరస్కరణ | cd | ఎప్పుడు |
|---|---|---|
| 400 | INVALID_TEMPLATE | హెడర్ రకానికి సరిపోదు, 30 కంటే ఎక్కువ వేరియబుల్లు ఉన్నాయి లేదా variableKeys ప్రతి దానికి సరిగ్గా ఒక్కసారి పేరు ఇవ్వదు |
| 403 | REGISTRY_NOT_ALLOWED | ఖాతా తన సొంత SMS నమోదు చేయదు |
| 404 | TEMPLATE_NOT_FOUND, SENDER_NOT_FOUND, ACCOUNT_NOT_FOUND | అలాంటి టెంప్లేట్, హెడర్ లేదా ఉపఖాతా లేదు |
| 409 | TEMPLATE_EXISTS | ఆ DLT ID తో టెంప్లేట్ ఇప్పటికే నమోదైంది |
| 409 | SENDER_IN_USE | టెంప్లేట్లు వాడుతున్న హెడర్ తొలగించడం |
| 422 | SENDER_NOT_ALLOWED | హెడర్ ఖాతాకు చెందదు |
| 422 | MESSAGE_TYPE_NOT_ENABLED | టెంప్లేట్ రకం Oblic పంపే రకాలలో లేదు: ఖాతా messageTypes, డిఫాల్ట్ కేవలం service_implicit |
WhatsApp నంబరు మరియు టెంప్లేట్లు
WhatsApp సందేశం ఖాతా అనుసంధానించిన WhatsApp Business నంబరు నుంచి Meta ఆమోదించిన టెంప్లేట్తో వెళ్తుంది.
| పద్ధతి | మార్గం | పని |
|---|---|---|
POST | /external/v1/whatsapp/connection | నంబరును అనుసంధానిస్తుంది లేదా అనుసంధానించినదాన్ని భర్తీ చేస్తుంది |
GET | /external/v1/whatsapp/connection | అనుసంధానించిన నంబరు; లేకపోతే 404 WHATSAPP_NOT_CONNECTED |
DELETE | /external/v1/whatsapp/connection | దాని అనుసంధానం తీసేస్తుంది: 204 |
GET | /external/v1/whatsapp/templates | టెంప్లేట్లు, ప్రతిదానిపై Meta సమీక్ష |
POST | /external/v1/whatsapp/templates | Meta సమీక్షకు టెంప్లేట్ ఇస్తుంది: 201 |
GET | /external/v1/whatsapp/recipients/{number} | ఖాతా ఇప్పుడు ఒక నంబరుకు ఏమి పంపవచ్చు |
అనుసంధానం Oblic Meta యాప్తో నడిపిన Embedded Signup ఫలితాన్ని వాడుతుంది: code, phoneNumberId, wabaId, ఐచ్ఛిక businessId, నంబరు నమోదుకు వాడిన ఆరు అంకెల pin. అన్ని అనుసంధాన దశలు నిర్ధారితమైనప్పుడు సమాధానంలోని status INTEGRATED అవుతుంది; మధ్యలో ఆగిన అనుసంధానం PENDING గా ఉంటుంది. చెల్లుబాటు అయ్యే సైన్అప్ సమాచారంతో మళ్లీ ప్రయత్నించండి; వాడిన లేదా గడువు ముగిసిన కోడ్ మళ్లీ పనిచేసే హామీ లేదు. Meta దశను తిరస్కరిస్తే 502, దాని కోడ్, ఉదాహరణకు WHATSAPP_REGISTER_REFUSED, వస్తాయి, అసలు సమాధాన బాడీ కాదు.
- పేరు
name- టైప్ చేయండి
- string
- వివరణ
తప్పనిసరి: చిన్న ASCII అక్షరాలు, అంకెలు,
_, ఉదాహరణకుorder_shipped. ఖాతా, భాషతో విస్తరించిన Oblic పేరు గరిష్ఠంగా 100 అక్షరాలు ఉండాలి; మించితే Meta కాల్కు ముందే తిరస్కరిస్తారు. పంపేటప్పుడు తిరిగివచ్చినnameవాడండి; చిన్న ఇన్పుట్ పేరే Meta నిల్వ చేసిన పేరు అనుకోకండి.
- పేరు
language- టైప్ చేయండి
- string
- వివరణ
టెంప్లేట్ భాష: రెండు చిన్న ASCII అక్షరాలు, ఐచ్ఛికంగా
_, రెండు పెద్ద ASCII అక్షరాలు, ఉదాహరణకుen,hiలేదాen_US; ఇవ్వకపోతేen. ఒక పేరుకు ప్రతి భాషలో టెంప్లేట్ ఉండవచ్చు; ఒకే పేరు, భాష మళ్లీ వాడితే ఘర్షణ అవుతుంది.
- పేరు
category- టైప్ చేయండి
- string
- వివరణ
తప్పనిసరి:
MARKETING,UTILITYలేదాAUTHENTICATION.
- పేరు
components- టైప్ చేయండి
- object[]
- వివరణ
తప్పనిసరి: Meta రూపంలో టెంప్లేట్ హెడర్, బాడీ, ఫుటర్, బటన్లు, వాటి వేరియబుల్ల ఉదాహరణలతో.
సమీక్షకు టెంప్లేట్ సమర్పించడం
curl -X POST https://api.oblic.app/external/v1/whatsapp/templates \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"name": "order_shipped",
"language": "en",
"category": "UTILITY",
"components": [
{
"type": "BODY",
"text": "Hi {{1}}, your order {{2}} has shipped.",
"example": { "body_text": [["Asha", "1042"]] }
}
]
}'
- టెంప్లేట్
statusMeta నుంచి నిల్వ చేసిన సమీక్ష స్థితి, ఉదాహరణకుPENDING,APPROVEDలేదాREJECTED;rejectionReasonలేకపోవచ్చు.201అంటే సమర్పించబడింది, ఆమోదించబడలేదు.APPROVEDటెంప్లేట్లనే పంపవచ్చు. సమీక్ష పూర్తయ్యే గడువు వాగ్దానం చేయబడదు. - స్వీకర్త సమాధానం
number,optedOut, ఎప్పుడు ఎలా (optedOutAt,optOutSource),lastInboundAt,sessionOpenUntilఇస్తుంది: వ్యక్తి చివరి ఇన్బౌండ్ సందేశం నుంచి లెక్కించే 24 గంటల వ్యవధి.optedOutమార్కెటింగ్కు సంబంధించినది, ప్రతి సందేశానికి కాదు. ఇన్బౌండ్ చరిత్ర లేకపోతేlastInboundAt,sessionOpenUntilnullఉంటాయి. సెషన్ టైమ్స్టాంప్ మాత్రమే పంపడం స్వీకరించబడుతుందని హామీ ఇవ్వదు; ఇతర తనిఖీలూ వర్తిస్తాయి.
| తిరస్కరణ | cd | ఎప్పుడు |
|---|---|---|
| 409 | TEMPLATE_EXISTS | ఆ పేరు, భాషతో ఖాతాలో టెంప్లేట్ ఉంది |
| 422 | WHATSAPP_NOT_CONNECTED | అనుసంధానించిన నంబరు లేకుండా టెంప్లేట్ సమర్పించడం |
| 422 | TEMPLATE_NAME_TOO_LONG | పేరు Meta కు చాలా పొడవుగా ఉంది |
| 422 | TEMPLATE_REFUSED | Meta టెంప్లేట్ తిరస్కరించింది; సాధారణ స్థానికీకరించిన తిరస్కరణ, Meta అసలు సమాధాన పాఠ్యం కాదు |
| 422 | INVALID_NUMBER | స్వీకర్త నంబరు అంతర్జాతీయ రూపంలో లేదు |
| 502 | WHATSAPP_CODE_REFUSED, WHATSAPP_SUBSCRIBE_REFUSED, WHATSAPP_REGISTER_REFUSED | నంబరు అనుసంధానించే దశను Meta తిరస్కరించింది |
| 503 | WHATSAPP_UNAVAILABLE | అనుసంధాన దశలో Meta ను చేరుకోలేకపోయింది |