ಟೆಂಪ್ಲೇಟ್ಗಳು
ಖಾತೆ ಕಳುಹಿಸಲು ಬಳಸುವ ಟೆಂಪ್ಲೇಟ್ಗಳನ್ನು ನಿರ್ವಹಿಸಿ: ಇಮೇಲ್ ಟೆಂಪ್ಲೇಟ್ಗಳು, 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 ತಲುಪಲಾಗಲಿಲ್ಲ |