Oblic API ಮೂಲಕ ನಿಮ್ಮ ಸರ್ವರ್ಗಳು ಸಂಸ್ಥೆಯ ಪರವಾಗಿ ಇಮೇಲ್, SMS ಮತ್ತು WhatsApp ಕಳುಹಿಸಿ ಫಲಿತಾಂಶ ನೋಡಬಹುದು, ನಿಮ್ಮ ವ್ಯವಸ್ಥೆಗಳಲ್ಲಿ ಸಂಪರ್ಕಗಳ ಚಟುವಟಿಕೆಗಳನ್ನು ದಾಖಲಿಸಬಹುದು ಮತ್ತು ಬಳಸುವ ಟೆಂಪ್ಲೇಟ್ಗಳು, ಕಳುಹಿಸುವವರ ಗುರುತುಗಳು, ಸಂಪರ್ಕ ಪಟ್ಟಿಗಳು, ವೆಬ್ಹುಕ್ಗಳು ಮತ್ತು ಉಪಖಾತೆಗಳನ್ನು ನಿರ್ವಹಿಸಬಹುದು. ಸರ್ವರ್ಗಳು API ಕೀಯೊಂದಿಗೆ ಇದನ್ನು ಕರೆಯುತ್ತವೆ.
ಈ ಆವೃತ್ತಿಯ OpenAPI ದಸ್ತಾವೇಜು external-v1.json: ಎಲ್ಲಾ ಮಾರ್ಗಗಳು, ಅಗತ್ಯ ಸ್ಕೋಪ್ಗಳು ಮತ್ತು ಸ್ವೀಕರಿಸುವ ವಿನಂತಿ ಬಾಡಿಗಳು ಇದರಲ್ಲಿ ಇವೆ; OpenAPI ಉಲ್ಲೇಖ ಅವನ್ನು ತೋರಿಸುತ್ತದೆ. API v2 API ಕೀಗಳ ಬದಲು OAuth ಪ್ರವೇಶ ಟೋಕನ್ಗಳನ್ನು ಬಳಸುತ್ತದೆ.
ಎಲ್ಲಾ ಪಥಗಳು https://api.oblic.app/external/v1 ನಿಂದ ಪ್ರಾರಂಭವಾಗುತ್ತವೆ; ಸಂಪರ್ಕ ಪಟ್ಟಿಗಳ ಹಳೆಯ ಪಥಗಳು ಮಾತ್ರ https://api.oblic.app/external/contact-list/v1 ನಿಂದ ಪ್ರಾರಂಭವಾಗುತ್ತವೆ.
API ಕೀ ಕಳುಹಿಸಿ, Authorization: Bearer <key> ರೂಪದಲ್ಲಿ. ಸೆಟ್ಟಿಂಗ್ಗಳು → API ಏಕೀಕರಣ ಅಡಿಯಲ್ಲಿ ಪ್ರತಿ ಕೀಯನ್ನು ಅಗತ್ಯ ಸ್ಕೋಪ್ಗಳೊಂದಿಗೆ ರಚಿಸಲಾಗುತ್ತದೆ. ಕೀಗಳನ್ನು ನಿಮ್ಮ ಸರ್ವರ್ಗಳಲ್ಲಿ ಇಡಿ: ಬ್ರೌಸರ್ ಅಥವಾ ಮೊಬೈಲ್ ಆ್ಯಪ್ನಲ್ಲಿರುವ ಕೀಯನ್ನು ಯಾರಾದರೂ ಓದಬಹುದು. ದೃಢೀಕರಣ ನೋಡಿ.
ಬಾಡಿಯಿರುವ ಉತ್ತರ ಒಂದೇ JSON ಆವರಣವನ್ನು ಬಳಸುತ್ತದೆ:{"status": "success", "data": …, "errors": null}, ಅಥವಾ ದೋಷಗಳೊಂದಿಗೆ "status": "error"; ಪ್ರತಿ ದೋಷಕ್ಕೆ ಕೋಡ್ (cd) ಮತ್ತು ಸಂದೇಶವಿರುತ್ತದೆ. ದೋಷಗಳು ನೋಡಿ.
ಪ್ಲಾಟ್ಫಾರ್ಮ್ ತನ್ನ ಗ್ರಾಹಕರ ಪರವಾಗಿ ಕಾರ್ಯನಿರ್ವಹಿಸುತ್ತದೆಉಪಖಾತೆಗಳ ಮೂಲಕ: ಒಂದೇ ಕೀ ಮತ್ತು ಪ್ರತಿ ವಿನಂತಿಯ X-Oblic-On-Behalf-Of ನಲ್ಲಿ ಸೂಚಿಸಲಾದ ಗ್ರಾಹಕ.
ಕೀ ಸ್ಥಿತಿ ಉಳಿದಿರುವಾಗ ಮರುಪ್ರಯತ್ನಿಸಿ, ಅದೇ Idempotency-Key ಮತ್ತು ಅದೇ ಬಾಡಿಯೊಂದಿಗೆ. ಇಮೇಲ್ ಮತ್ತು WhatsApp ಕೀಗಳು Redis ನಲ್ಲಿ 24 ಗಂಟೆಗಳಿರುತ್ತವೆ; ಕ್ಯಾಶ್ ಕಳೆದುಹೋದರೆ ಅಥವಾ ಅವಧಿ ಮುಗಿದರೆ ಮತ್ತೊಮ್ಮೆ ಕಳುಹಿಸಲು ಅವಕಾಶವಾಗಬಹುದು. SMS ಕೀ ಸಂಗ್ರಹಿಸಿದ ಸಂದೇಶದ ಸಾಲಿನಲ್ಲಿ ಉಳಿಯುತ್ತದೆ; ಸಮಯಾಧಾರಿತ ಮುಕ್ತಾಯವಿಲ್ಲ. ಇದು ಶಾಶ್ವತವಾಗಿ ನಿಖರವಾಗಿ ಒಮ್ಮೆ ಮಾತ್ರ ಕಾರ್ಯಗತಗೊಳ್ಳುವ ಖಾತರಿಯಲ್ಲ. ಸಂದೇಶಗಳು ನೋಡಿ.
ಯಶಸ್ವಿ ಕಳುಹಿಸುವ ವಿನಂತಿ ಎಂದರೆ ಸ್ವೀಕಾರ, ಪೂರೈಕೆದಾರರ ವಿತರಣೆ ಅಲ್ಲ. ವಿತರಣೆಗೆ ಹೊರಹೋಗುವ ಕಳುಹಿಸುವಿಕೆ ಸಕ್ರಿಯವಾಗಿರಬೇಕು, ಕನ್ಸ್ಯೂಮರ್ಗಳು ಚಾಲನೆಯಲ್ಲಿರಬೇಕು ಮತ್ತು ಪೂರೈಕೆದಾರರು ಸಂರಚಿತರಾಗಿರಬೇಕು. ಹೊರಹೋಗುವ ಕಳುಹಿಸುವಿಕೆ ನಿಷ್ಕ್ರಿಯವಾಗಿರುವ ನಿಯೋಜನೆಯಲ್ಲಿ ಸ್ವೀಕರಿಸಿದ ವಿನಂತಿ ಎಂದರೆ ಸಂದೇಶ ಕಳುಹಿಸಲಾಗುತ್ತದೆ ಎಂದಲ್ಲ. ವಿತರಣೆಯ ಗಡುವಿಗೆ ಖಾತರಿಯಿಲ್ಲ.
ಕ್ಷಣವನ್ನು ಸೂಚಿಸುವ ಉತ್ತರ ಸಮಯಮುದ್ರೆಗಳಲ್ಲಿ ISO 8601 ಆಫ್ಸೆಟ್ ಇರುತ್ತದೆ. ಉದಾಹರಣೆಗೆ, 2026-10-30T20:00:00Z ಮತ್ತು 2026-10-31T01:30:00+05:30 ಒಂದೇ ಕ್ಷಣವನ್ನು ಸೂಚಿಸುತ್ತವೆ. ಓದುಗರ ಸಮಯವಲಯದಲ್ಲಿ ತೋರಿಸುವ ಮೊದಲು ಆಫ್ಸೆಟ್ ಪಾರ್ಸ್ ಮಾಡಿ. JavaScript ನ new Date(value) ಮತ್ತು Java ದ OffsetDateTime.parse(value) ಇದನ್ನು ಮಾಡುತ್ತವೆ; ಆಫ್ಸೆಟ್ ಇಲ್ಲದ ಮೌಲ್ಯಕ್ಕೆ Z ಸೇರಿಸುವುದು ಅಥವಾ ಕ್ಷಣವನ್ನು LocalDateTime ಎಂದು ಪಾರ್ಸ್ ಮಾಡುವುದು ಇದನ್ನು ಮಾಡುವುದಿಲ್ಲ.
ದಿನಾಂಕ ಮಾತ್ರವಿರುವ ಮೌಲ್ಯ ದಿನಾಂಕವಾಗಿಯೇ ಉಳಿಯುತ್ತದೆ. ಸ್ಪಷ್ಟ ಸ್ಥಳೀಯ ವೇಳಾಪಟ್ಟಿಗೆ ಪ್ರತ್ಯೇಕ ಒಪ್ಪಂದವಿದೆ: ಅದರ ಗಡಿಯಾರ ಸಮಯವನ್ನು ಸಮಯವಲಯ ಕ್ಷೇತ್ರದೊಂದಿಗೆ ಜೋಡಿಸಲಾಗುತ್ತದೆ; ಅದನ್ನು ಒಂಟಿಯಾಗಿ ಕ್ಷಣವೆಂದು ಪರಿಗಣಿಸುವುದಿಲ್ಲ.
«ಅಗತ್ಯ» ಮಾರ್ಗಕ್ಕಾಗಿ ಕೀಯಲ್ಲಿ ಇರಬೇಕಾದ ಸ್ಕೋಪ್ ಅನ್ನು ಸೂಚಿಸುತ್ತದೆ; ಹಲವು ಇದ್ದರೆ ಯಾವುದಾದರೂ ಒಂದು ಸಾಕು. ಕೆಲವು ಮಾರ್ಗಗಳಿಗೆ ಮಾಲೀಕ ಅಥವಾ ನಿರ್ವಾಹಕ ಪಾತ್ರದ ಕೀಯೂ ಅಗತ್ಯ. ಸ್ಕೋಪ್ ಮತ್ತು ಪಾತ್ರ ಅನುಮತಿ ನೀಡುತ್ತವೆ, ಆದರೆ ಸೇವಾ ಸಂರಚನೆ ಹಾಗೂ ಸಂಪನ್ಮೂಲ ಅರ್ಹತೆ ಇನ್ನೂ ವಿನಂತಿಯನ್ನು ನಿರಾಕರಿಸಬಹುದು.
API ಸಂದೇಶಗಳು
ವಿಧಾನ
ಪಥ
ಕಾರ್ಯ
ಅಗತ್ಯ
GET
/external/v1/messages
API ಮೂಲಕ ಕಳುಹಿಸಿದ ಸಂದೇಶಗಳು, ಹೊಸವು ಮೊದಲು
messages:read
POST
/external/v1/messages/email
ಪರಿಶೀಲಿತ ಕಳುಹಿಸುವವರಿಂದ ಸ್ವಂತ HTML ಅಥವಾ ಟೆಂಪ್ಲೇಟ್ನೊಂದಿಗೆ ಇಮೇಲ್ ಕಳುಹಿಸಿ
email:send
POST
/external/v1/messages/sms
ಖಾತೆಯ DLT ಟೆಂಪ್ಲೇಟ್ಗೆ ಹೊಂದುವ SMS ಕಳುಹಿಸಿ
sms:send
POST
/external/v1/messages/whatsapp
ಅನುಮೋದಿತ WhatsApp ಟೆಂಪ್ಲೇಟ್ ಅಥವಾ 24 ಗಂಟೆಗಳೊಳಗೆ ಉತ್ತರ ಕಳುಹಿಸಿ
whatsapp:send
GET
/external/v1/messages/{messageId}
API ಮೂಲಕ ಕಳುಹಿಸಿದ ಸಂದೇಶ ಮತ್ತು ಅದರ ಫಲಿತಾಂಶ
messages:read
ವರದಿಗಳು
ವಿಧಾನ
ಪಥ
ಕಾರ್ಯ
ಅಗತ್ಯ
GET
/external/v1/reports/summary
ಅವಧಿಯಲ್ಲಿ ಕಳುಹಿಸಿದ ಸಂದೇಶಗಳ ಫಲಿತಾಂಶ, ಚಾನಲ್ ಮತ್ತು ಸ್ಥಿತಿಯ ಪ್ರಕಾರ
messages:read
ಇಮೇಲ್ ಟೆಂಪ್ಲೇಟ್ಗಳು
ವಿಧಾನ
ಪಥ
ಕಾರ್ಯ
ಅಗತ್ಯ
GET
/external/v1/templates
ಖಾತೆಯ ಇಮೇಲ್ ಟೆಂಪ್ಲೇಟ್ಗಳು, ಹೊಸವು ಮೊದಲು
email:send ಅಥವಾ templates:manage
POST
/external/v1/templates
HTML ನಿಂದ ಇಮೇಲ್ ಟೆಂಪ್ಲೇಟ್ ರಚಿಸಿ
templates:manage, ಮಾಲೀಕ ಅಥವಾ ನಿರ್ವಾಹಕ ಕೀ
GET
/external/v1/templates/{id}
ಇಮೇಲ್ ಟೆಂಪ್ಲೇಟ್, ಅದರ HTML ಮತ್ತು ಸ್ವೀಕರಿಸುವ ಚರಗಳು
email:send ಅಥವಾ templates:manage
PUT
/external/v1/templates/{id}
HTML ನಿಂದ ರಚಿಸಿದ ಇಮೇಲ್ ಟೆಂಪ್ಲೇಟ್ ಬದಲಿಸಿ
templates:manage, ಮಾಲೀಕ ಅಥವಾ ನಿರ್ವಾಹಕ ಕೀ
DELETE
/external/v1/templates/{id}
ಇಮೇಲ್ ಟೆಂಪ್ಲೇಟ್ ಅಳಿಸಿ
templates:manage, ಮಾಲೀಕ ಅಥವಾ ನಿರ್ವಾಹಕ ಕೀ
SMS ಹೆಡರ್ಗಳು ಮತ್ತು ಟೆಂಪ್ಲೇಟ್ಗಳು
ಅಗತ್ಯ ಸ್ಕೋಪ್ ಮತ್ತು ಪಾತ್ರ ಇದ್ದರೂ ಸಂರಚಿಸಿದ ನೋಂದಣಿ ಖಾತೆಗಳು ಮಾತ್ರ SMS ನೋಂದಣಿಯನ್ನು ಬದಲಿಸಬಹುದು. ಈ ಮಾರ್ಗಗಳು ಈಗಾಗಲೇ DLT ಯಲ್ಲಿ ನೋಂದಾಯಿತ ಹೆಡರ್ಗಳು ಮತ್ತು ಟೆಂಪ್ಲೇಟ್ಗಳನ್ನು ದಾಖಲಿಸುತ್ತವೆ; DLT ನೋಂದಣಿ ಮಾಡುವುದಿಲ್ಲ. ಪಟ್ಟಿಗಳಲ್ಲಿ ನಿಷ್ಕ್ರಿಯವಾದವು ಸೇರಿದಂತೆ ಅನುಮೋದಿತ ಟೆಂಪ್ಲೇಟ್ಗಳಿರುತ್ತವೆ; ಕಳುಹಿಸುವ ಅರ್ಹತೆಗೆ ಹೆಚ್ಚುವರಿ ಪರಿಶೀಲನೆಗಳಿವೆ.
ವಿಧಾನ
ಪಥ
ಕಾರ್ಯ
ಅಗತ್ಯ
GET
/external/v1/sms/account
ಖಾತೆಯ SMS ಮಿತಿಗಳು ಮತ್ತು ಈ ತಿಂಗಳ ಕಳುಹಿಸುವಿಕೆಗಳು
sms:send ಅಥವಾ templates:manage
GET
/external/v1/sms/senders
ಖಾತೆಯ DLT ಹೆಡರ್ಗಳು
sms:send ಅಥವಾ templates:manage
GET
/external/v1/sms/templates
ಖಾತೆಯ DLT ಟೆಂಪ್ಲೇಟ್ಗಳು
sms:send ಅಥವಾ templates:manage
POST
/external/v1/sms/templates
ಈಗಾಗಲೇ DLT ನೋಂದಾಯಿತ ಟೆಂಪ್ಲೇಟ್ ಅನ್ನು Oblic ನಲ್ಲಿ ದಾಖಲಿಸಿ
templates:manage, ಮಾಲೀಕ ಅಥವಾ ನಿರ್ವಾಹಕ ಕೀ
PUT
/external/v1/sms/senders/{senderId}
DLT ಹೆಡರ್ ದಾಖಲಿಸಿ ಅಥವಾ ಅದರ ಡೀಫಾಲ್ಟ್ ಆಯ್ಕೆ ಬದಲಿಸಿ
templates:manage, ಮಾಲೀಕ ಅಥವಾ ನಿರ್ವಾಹಕ ಕೀ
DELETE
/external/v1/sms/senders/{senderId}
DLT ಹೆಡರ್ ಅಳಿಸಿ
templates:manage, ಮಾಲೀಕ ಅಥವಾ ನಿರ್ವಾಹಕ ಕೀ
PUT
/external/v1/sms/templates/{id}
DLT ಟೆಂಪ್ಲೇಟ್ ಬದಲಿಸಿ
templates:manage, ಮಾಲೀಕ ಅಥವಾ ನಿರ್ವಾಹಕ ಕೀ
DELETE
/external/v1/sms/templates/{id}
DLT ಟೆಂಪ್ಲೇಟ್ ಅಳಿಸಿ
templates:manage, ಮಾಲೀಕ ಅಥವಾ ನಿರ್ವಾಹಕ ಕೀ
PUT
/external/v1/sms/templates/{id}/sharing
ಯಾವುದೇ ಉಪಖಾತೆಗೆ ಬೇಡ, ಎಲ್ಲರಿಗೂ ಅಥವಾ ಸೂಚಿಸಿದ ಉಪಖಾತೆಗಳಿಗೆ ಟೆಂಪ್ಲೇಟ್ ಕಳುಹಿಸಲು ಅನುಮತಿಸಿ
templates:manage, ಮಾಲೀಕ ಅಥವಾ ನಿರ್ವಾಹಕ ಕೀ
WhatsApp ಸಂಖ್ಯೆ ಮತ್ತು ಟೆಂಪ್ಲೇಟ್ಗಳು
ವಿಧಾನ
ಪಥ
ಕಾರ್ಯ
ಅಗತ್ಯ
GET
/external/v1/whatsapp/connection
ಖಾತೆಗೆ ಸಂಪರ್ಕಿತ WhatsApp ಸಂಖ್ಯೆ
whatsapp:send ಅಥವಾ templates:manage
POST
/external/v1/whatsapp/connection
ಖಾತೆಯ WhatsApp Business ಸಂಖ್ಯೆ ಸಂಪರ್ಕಿಸಿ ಅಥವಾ ಬದಲಿಸಿ
templates:manage, ಮಾಲೀಕ ಅಥವಾ ನಿರ್ವಾಹಕ ಕೀ
DELETE
/external/v1/whatsapp/connection
ಖಾತೆಯ WhatsApp ಸಂಖ್ಯೆ ಸಂಪರ್ಕ ಕಡಿತಗೊಳಿಸಿ
templates:manage, ಮಾಲೀಕ ಅಥವಾ ನಿರ್ವಾಹಕ ಕೀ
GET
/external/v1/whatsapp/templates
ಖಾತೆಯ WhatsApp ಟೆಂಪ್ಲೇಟ್ಗಳು ಮತ್ತು ಪ್ರತಿಯೊಂದರ Meta ಪರಿಶೀಲನೆ
whatsapp:send ಅಥವಾ templates:manage
POST
/external/v1/whatsapp/templates
WhatsApp ಟೆಂಪ್ಲೇಟ್ ಅನ್ನು Meta ಪರಿಶೀಲನೆಗೆ ಸಲ್ಲಿಸಿ
templates:manage, ಮಾಲೀಕ ಅಥವಾ ನಿರ್ವಾಹಕ ಕೀ
GET
/external/v1/whatsapp/recipients/{number}
ಖಾತೆ ಈಗ ಒಂದು ಸಂಖ್ಯೆಗೆ ಏನು ಕಳುಹಿಸಬಹುದು
whatsapp:send ಅಥವಾ templates:manage
ಕಳುಹಿಸುವವರ ಗುರುತುಗಳು
ವಿಧಾನ
ಪಥ
ಕಾರ್ಯ
ಅಗತ್ಯ
GET
/external/v1/identities
ಕಳುಹಿಸುವ ಡೊಮೇನ್ಗಳು ಮತ್ತು ವಿಳಾಸಗಳು ಹಾಗೂ ಪರಿಶೀಲನಾ ಸ್ಥಿತಿ
email:send ಅಥವಾ identities:manage
POST
/external/v1/identities
ಪರಿಶೀಲನೆಗಾಗಿ ಕಳುಹಿಸುವ ಡೊಮೇನ್ ಅಥವಾ ವಿಳಾಸ ಸೇರಿಸಿ
identities:manage
DELETE
/external/v1/identities/{identityId}
ಕಳುಹಿಸುವವರ ಗುರುತು ಅಳಿಸಿ
identities:manage
ಸಂಪರ್ಕ ಪಟ್ಟಿಗಳು
ವಿಧಾನ
ಪಥ
ಕಾರ್ಯ
ಅಗತ್ಯ
POST
/external/contact-list/v1/add
ಸಂಪರ್ಕ ಪಟ್ಟಿ ರಚಿಸಿ
contacts:manage
POST
/external/contact-list/v1/{contactListId}/add
ಪಟ್ಟಿಗೆ ಸಂಪರ್ಕಗಳನ್ನು ಸೇರಿಸಿ
contacts:manage
GET
/external/contact-list/v1/{nextIndex}/{limit}
ಖಾತೆಯ ಸಂಪರ್ಕ ಪಟ್ಟಿಗಳು, ಒಂದೊಂದು ಪುಟವಾಗಿ
contacts:manage
ಘಟನೆಗಳು
ವಿಧಾನ
ಪಥ
ಕಾರ್ಯ
ಅಗತ್ಯ
POST
/external/v1/events
ಆರ್ಡರ್ ಅಥವಾ ತ್ಯಜಿಸಿದ ಕಾರ್ಟ್ಗಳಂತಹ ಗರಿಷ್ಠ 100 ಸಂಪರ್ಕ ಘಟನೆಗಳನ್ನು ದಾಖಲಿಸಿ
events:write
API ವೆಬ್ಹುಕ್ಗಳು
ವಿಧಾನ
ಪಥ
ಕಾರ್ಯ
ಅಗತ್ಯ
GET
/external/v1/webhooks
ಸಂಸ್ಥೆಯ ವೆಬ್ಹುಕ್ ಎಂಡ್ಪಾಯಿಂಟ್ಗಳು
webhooks:manage, ಮಾಲೀಕ ಅಥವಾ ನಿರ್ವಾಹಕ ಕೀ
POST
/external/v1/webhooks
ವೆಬ್ಹುಕ್ ಎಂಡ್ಪಾಯಿಂಟ್ ನೋಂದಾಯಿಸಿ ಅಥವಾ ಅದೇ URL ಇರುವುದನ್ನು ಹುಡುಕಿ