API ಸಂದೇಶಗಳು
ನಿಮ್ಮ ಸಂಸ್ಥೆಯ ಪರವಾಗಿ ಇಮೇಲ್, SMS ಮತ್ತು WhatsApp ಸಂದೇಶಗಳನ್ನು ಕಳುಹಿಸಿ. ದಾಖಲಿಸಿದ ಉಳಿಸುವ ಮಿತಿಯೊಳಗೆ ಮರುಪ್ರಯತ್ನಿಸಲು ಇಡೆಂಪೋಟೆನ್ಸಿ ಕೀ ಬಳಸಿ ಮತ್ತು ಪ್ರತಿ ಸಂದೇಶದ ಫಲಿತಾಂಶವನ್ನು ಪ್ರತ್ಯೇಕವಾಗಿ ಅಥವಾ ವರದಿಯಲ್ಲಿ ನೋಡಿ.
ಯಶಸ್ವಿ ಕಳುಹಿಸುವ ವಿನಂತಿಯು ಸಾಮಾನ್ಯವಾಗಿ 202 Accepted ಜೊತೆಗೆ ID ಮತ್ತು ಸ್ಥಿತಿಯನ್ನು ಕೊಡುತ್ತದೆ. ಸ್ವೀಕರಿಸುವುದು ಎಂದರೆ ಪೂರೈಕೆದಾರರಿಂದ ತಲುಪಿಸುವುದಲ್ಲ: ಕಳುಹಿಸಲು ಹೊರಹೋಗುವ ವಿತರಣೆ ಸಕ್ರಿಯವಾಗಿರಬೇಕು, ಚಾನೆಲ್ ಕನ್ಸ್ಯೂಮರ್ಗಳು ಓಡಬೇಕು ಮತ್ತು ಚಾನೆಲ್ನ ಪೂರೈಕೆದಾರ ಹೊಂದಿಸಿರಬೇಕು. ತಲುಪುವ ಸಮಯದ ಖಾತರಿ ಇಲ್ಲ. ಹೊರಹೋಗುವ ವಿತರಣೆ ನಿಷ್ಕ್ರಿಯವಾದ ನಿಯೋಜನೆಯಲ್ಲಿ ವಿನಂತಿ ಸ್ವೀಕಾರವಾದರೂ ಸಂದೇಶ ಕಳುಹಿಸಲಾಗುತ್ತದೆ ಎಂದಲ್ಲ. ಅದರ ID, msg_ ನಂತರ 32 ಹೆಕ್ಸಾಡೆಸಿಮಲ್ ಅಕ್ಷರಗಳು, ಮೂಲಕ ಇಲ್ಲಿ ಅಥವಾ ವೆಬ್ಹುಕ್ನಲ್ಲಿ ಫಲಿತಾಂಶ ಓದಬಹುದು.
202 ಸ್ವೀಕರಿಸಲಾಗಿದೆ
{
"status": "success",
"data": { "id": "msg_4f9c2a1e8b7d4c3f9e0a1b2c3d4e5f60", "status": "queued" },
"errors": null
}
ಇಮೇಲ್ ಕಳುಹಿಸುವುದು
ಇಮೇಲ್ ನಿಮ್ಮ ಸಂಸ್ಥೆಯ ಪರಿಶೀಲಿಸಿದ ಕಳುಹಿಸುವವರ ಗುರುತುಗಳಲ್ಲಿ ಒಂದರಿಂದ ಹೋಗುತ್ತದೆ; ಸ್ವಂತ 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 ಅಕ್ಷರಗಳು;
<,>,"ಅಥವಾ ಸಾಲುಮುರಿತ ಇರಬಾರದು. ನೀಡದಿದ್ದರೆ ಗುರುತಿನ ಪ್ರದರ್ಶನ ಹೆಸರು ಬಳಸಲಾಗುತ್ತದೆ. ಗುರುತಿನ ಪರವಾಗಿ ಕಳುಹಿಸುವಾಗ Oblicvia 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 ಮೇಲೆ ನಿರಾಕರಿಸಲಾಗುತ್ತದೆ |
| 400 | INVALID_REQUEST | html ಮತ್ತು templateId ಯಾವುದೂ ಇಲ್ಲ ಅಥವಾ ಎರಡೂ ಇವೆ; ಟೆಂಪ್ಲೇಟ್ ಇಲ್ಲದೆ variables ಇದೆ ಅಥವಾ ವಿಷಯ ಇಲ್ಲ |
| 400 | INVALID_VARIABLES | ಪ್ಲೇಸ್ಹೋಲ್ಡರ್ಗೆ ಮೌಲ್ಯ ಇಲ್ಲ, ದೊಡ್ಡ-ಸಣ್ಣ ಅಕ್ಷರದ ವ್ಯತ್ಯಾಸದಿಂದ ಹೆಸರು ಎರಡು ಬಾರಿ ಬಂದಿದೆ ಅಥವಾ ತುಂಬಿದ ವಿಷಯ ಬಹಳ ಉದ್ದವಾಗಿದೆ |
| 400 | INVALID FILE | ಲಗತ್ತು ಬಹಳ ದೊಡ್ಡದು ಅಥವಾ ಅನುಮತಿಸದ ಪ್ರಕಾರ |
| 403 | EMAIL_SUSPENDED | ಬೌನ್ಸ್ ಅಥವಾ ಸ್ಪ್ಯಾಮ್ ದೂರುಗಳಿಂದ ಖಾತೆಯ ಇಮೇಲ್ ಅಮಾನತುಗೊಂಡಿದೆ; Oblic ಬೆಂಬಲ ತೆಗೆದುಹಾಕುವವರೆಗೆ ಮುಂದುವರಿಯುತ್ತದೆ |
| 413 | MESSAGE_TOO_LARGE | ಇಮೇಲ್ ಸರದಿಯಲ್ಲಿ ಇಡಲು ಬಹಳ ದೊಡ್ಡದು |
| 422 | UNVERIFIED_SENDER | from ಪರಿಶೀಲಿಸಿದ ಗುರುತಿಗೆ ಸೇರಿಲ್ಲ; ಸಂದೇಶ ಪರಿಶೀಲಿಸಿದ ಗುರುತುಗಳನ್ನು ಪಟ್ಟಿ ಮಾಡುತ್ತದೆ |
| 422 | TEMPLATE_NOT_FOUND | ಆ ID ಹೊಂದಿರುವ ಇಮೇಲ್ ಟೆಂಪ್ಲೇಟ್ ಇಲ್ಲ |
| 422 | TEMPLATE_HAS_MENTIONS | ಟೆಂಪ್ಲೇಟ್ನಲ್ಲಿ @unsubscribe ಮುಂತಾದ ಡ್ಯಾಶ್ಬೋರ್ಡ್ ಉಲ್ಲೇಖಗಳಿವೆ; ಅವನ್ನು ಅಭಿಯಾನಗಳು ಮತ್ತು ಸ್ವಯಂಚಾಲನೆಗಳು ಮಾತ್ರ ತುಂಬುತ್ತವೆ |
| 429 | RATE_LIMITED | ಖಾತೆಯ ಗಂಟೆಗೊಮ್ಮೆ ಮಿತಿ (ಪೂರ್ವನಿಯೋಜಿತ 5,000 ಸ್ವೀಕರಿಸುವವರು) ಅಥವಾ ಒಂದು ವಿಳಾಸದ ಮಿತಿ (ಪೂರ್ವನಿಯೋಜಿತ ಗಂಟೆಗೆ 10) ಮೀರಿದೆ; ಪ್ರತಿ ಕಳುಹಿಸುವಿಕೆಯಲ್ಲಿ ಎಲ್ಲ ಪಟ್ಟಿಗಳ ಪ್ರಮಾಣೀಕೃತ ವಿಭಿನ್ನ ಸ್ವೀಕರಿಸುವವರನ್ನು ಎಣಿಸಲಾಗುತ್ತದೆ, ಆದ್ದರಿಂದ ಆ ಕಳುಹಿಸುವಿಕೆಯಲ್ಲಿ ಪುನರಾವರ್ತಿತ ವಿಳಾಸವನ್ನು ಒಮ್ಮೆ ಮಾತ್ರ ಎಣಿಸಲಾಗುತ್ತದೆ. Retry-After ಸಮಯವನ್ನು ತಿಳಿಸುತ್ತದೆ |
| 429 | QUOTA_EXCEEDED | ಖಾತೆಯ ತಿಂಗಳ ಸಂದೇಶ ಮಿತಿ ಮೀರಿದೆ (ಡೀಫಾಲ್ಟ್ 100,000); Retry-After ಮರುಪ್ರಯತ್ನದ ಸಮಯ ಹೇಳುತ್ತದೆ |
ಖ್ಯಾತಿ ವರ್ಕರ್ ಸಕ್ರಿಯವಾಗಿದ್ದರೆ ಅದರ ಬದಲಿಸಬಹುದಾದ ಡೀಫಾಲ್ಟ್ ಸೆಟ್ಟಿಂಗ್ಗಳು ಪ್ರತಿ ಖಾತೆಯ ಕಳೆದ 7 ದಿನಗಳ ಇಮೇಲ್ ಅನ್ನು 500 ಸ್ವೀಕರಿಸುವವರಿಗೆ ಕಳುಹಿಸಿದ ನಂತರ ಪರಿಶೀಲಿಸುತ್ತವೆ: 2% ಬೌನ್ಸ್ ಅಥವಾ 0.05% ಸ್ಪ್ಯಾಮ್ ದೂರುಗಳಿಗೆ ಮಾಲೀಕರಿಗೆ ಎಚ್ಚರಿಕೆ; 4% ಅಥವಾ 0.08% ತಲುಪಿದಾಗ Oblic ಬೆಂಬಲ ತೆಗೆದುಹಾಕುವವರೆಗೆ ಇಮೇಲ್ ಅಮಾನತು. ಈ ಡೀಫಾಲ್ಟ್ಗಳಲ್ಲಿ ಸ್ಪ್ಯಾಮ್ ದೂರುಗಳನ್ನು 1,251 ಸ್ವೀಕರಿಸುವವರಿಗೆ ಕಳುಹಿಸಿದ ನಂತರವೇ ಅಳೆಯುವುದರಿಂದ ಒಂದೇ ದೂರು ಖಾತೆಯನ್ನು ಅಮಾನತುಗೊಳಿಸುವುದಿಲ್ಲ. ಶಾಶ್ವತ ಬೌನ್ಸ್ ಮಾತ್ರ, ಪ್ರತಿ ಸ್ವೀಕರಿಸುವವರು ಒಮ್ಮೆ ಮಾತ್ರ ಲೆಕ್ಕವಾಗುತ್ತಾರೆ. ವಿರಾಮದಲ್ಲಿರುವ ಅಥವಾ ನಿಷ್ಕ್ರಿಯ ವರ್ಕರ್ ಈ ನಿಯತಕಾಲಿಕ ಪರಿಶೀಲನೆ ಮಾಡುವುದಿಲ್ಲ. ಖಾತೆ ಅಮಾನತಿನಲ್ಲಿದ್ದಾಗ ಇಮೇಲ್ EMAIL_SUSPENDED ಮೂಲಕ ನಿರಾಕರಿಸಲಾಗುತ್ತದೆ; ಹಿಂದೆ ಸ್ವೀಕರಿಸಿ ಇನ್ನೂ ಕಳುಹಿಸದ ಇಮೇಲ್ email.failed ಈವೆಂಟ್ ಜೊತೆ ವಿಫಲವಾಗುತ್ತದೆ; ಅದರ failureCode EMAIL_SUSPENDED ಆಗಿರುತ್ತದೆ.
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 | ಯಾವಾಗ |
|---|---|---|
| 400 | INVALID_NUMBER | to ಭಾರತೀಯ ಮೊಬೈಲ್ ಸಂಖ್ಯೆ ಅಲ್ಲ |
| 400 | INVALID_REQUEST | text ಮತ್ತು templateId ಯಾವುದೂ ಇಲ್ಲ ಅಥವಾ ಎರಡೂ ಇವೆ |
| 400 | INVALID_VARIABLES | ಚರಗಳು ಟೆಂಪ್ಲೇಟ್ಗೆ ಹೊಂದುವುದಿಲ್ಲ |
| 402 | INSUFFICIENT_BALANCE | SMS ಪ್ರಚಾರದದ್ದು ಮತ್ತು ಖಾತೆಗೆ ಪಾವತಿಸುವ ವಾಲೆಟ್ ಖಾಲಿಯಾಗಿದೆ |
| 422 | TEMPLATE_NOT_REGISTERED | ಪಠ್ಯ ಅಥವಾ templateId ಖಾತೆಗೆ ಅನುಮತಿಸಿದ ಯಾವ ಟೆಂಪ್ಲೇಟ್ಗೂ ಅಥವಾ senderId ಕೆಳಗಿನ ಯಾವ ಟೆಂಪ್ಲೇಟ್ಗೂ ಹೊಂದುವುದಿಲ್ಲ |
| 422 | SENDER_NOT_ALLOWED | senderId ಖಾತೆಗೆ ಅನುಮತಿಸಿದ ಯಾವುದೇ ಟೆಂಪ್ಲೇಟ್ನ ಹೆಡರ್ ಅಲ್ಲ |
| 422 | MESSAGE_TYPE_NOT_ENABLED | ಟೆಂಪ್ಲೇಟ್ ಪ್ರಕಾರವನ್ನು Oblic ಕಳುಹಿಸುವುದಿಲ್ಲ: ಕಳುಹಿಸುವ ಪ್ರಕಾರಗಳು ಖಾತೆಯ messageTypes; ಡೀಫಾಲ್ಟ್ನಲ್ಲಿ service_implicit ಮಾತ್ರ |
| 422 | URL_NOT_WHITELISTED | ಒಂದು ಚರದಲ್ಲಿ DLT ಅನುಮತಿ ಪಟ್ಟಿಯಲ್ಲಿಲ್ಲದ ಡೊಮೇನ್ನ ಲಿಂಕ್ ಇದೆ |
| 422 | OUTSIDE_PROMOTIONAL_HOURS | ಭಾರತದ ಸಮಯ 10:00 ರಿಂದ 21:00 ಹೊರಗಿನ ಪ್ರಚಾರ SMS; Retry-After ಮರುಪ್ರಯತ್ನದ ಸಮಯ ಹೇಳುತ್ತದೆ |
| 429 | RATE_LIMITED | ಖಾತೆಯ ಗಂಟೆಯ ಮಿತಿ ಮೀರಿದೆ (ಡೀಫಾಲ್ಟ್ 1,000 ಸಂದೇಶಗಳು), ಅಥವಾ ಒಂದು ಸಂಖ್ಯೆಯ ಮಿತಿ (ಡೀಫಾಲ್ಟ್ ಗಂಟೆಗೆ 10); Retry-After ಮರುಪ್ರಯತ್ನದ ಸಮಯ ಹೇಳುತ್ತದೆ |
| 429 | QUOTA_EXCEEDED | ಖಾತೆಯ ತಿಂಗಳ ಸೆಗ್ಮೆಂಟ್ ಮಿತಿ ಮೀರಿದೆ (ಡೀಫಾಲ್ಟ್ 10,000); Retry-After ಮರುಪ್ರಯತ್ನದ ಸಮಯ ಹೇಳುತ್ತದೆ |
| 503 | SMS_UNAVAILABLE | ಈಗ SMS ಸರದಿಯಲ್ಲಿ ಇಡಲಾಗಲಿಲ್ಲ; ಅದೇ Idempotency-Key ಜೊತೆ ಮರುಪ್ರಯತ್ನಿಸಿ; ಅಥವಾ ಈ Oblicನಲ್ಲಿ SMS ಹೊಂದಿಸಲಾಗಿಲ್ಲ |
GET /external/v1/sms/account ಖಾತೆಯ ಮಿತಿಗಳು, Oblic ಕಳುಹಿಸುವ ಟೆಂಪ್ಲೇಟ್ ಪ್ರಕಾರಗಳು ಮತ್ತು ಈ ತಿಂಗಳ ಕಳುಹಿಸಿದ ಬಳಕೆ ತೋರಿಸುತ್ತದೆ.
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 | ಯಾವಾಗ |
|---|---|---|
| 400 | INVALID_REQUEST | template ಮತ್ತು text ಯಾವುದೂ ಇಲ್ಲ ಅಥವಾ ಎರಡೂ ಇವೆ; ಅಥವಾ headerVariables ಅಥವಾ headerMediaUrl ಅನ್ನು text ಜೊತೆ ನೀಡಲಾಗಿದೆ |
| 402 | INSUFFICIENT_BALANCE | ಮಾರ್ಕೆಟಿಂಗ್ ಟೆಂಪ್ಲೇಟ್ ಮತ್ತು ಖಾತೆಗೆ ಪಾವತಿಸುವ ವಾಲೆಟ್ ಖಾಲಿಯಾಗಿದೆ |
| 422 | INVALID_NUMBER | to ಅಂತರರಾಷ್ಟ್ರೀಯ ರೂಪದ ಸಂಖ್ಯೆ ಅಲ್ಲ |
| 422 | WHATSAPP_NOT_CONNECTED | ಖಾತೆಗೆ WhatsApp ಸಂಖ್ಯೆ ಸಂಪರ್ಕಿಸಿಲ್ಲ |
| 422 | TEMPLATE_NOT_FOUND | ಖಾತೆಯಲ್ಲಿ ಆ ಹೆಸರಿನ ಆ ಭಾಷೆಯ ಟೆಂಪ್ಲೇಟ್ ಇಲ್ಲ |
| 422 | TEMPLATE_NOT_APPROVED | Meta ಟೆಂಪ್ಲೇಟ್ ಅನುಮೋದಿಸಿಲ್ಲ |
| 422 | INVALID_VARIABLES | ಚರಗಳ ಸಂಖ್ಯೆ ಟೆಂಪ್ಲೇಟ್ನ ಮುಖ್ಯ ಭಾಗ ಅಥವಾ ಪಠ್ಯ ಹೆಡರ್ಗೆ ಹೊಂದುವುದಿಲ್ಲ; ಅಥವಾ ಮಾಧ್ಯಮ ಹೆಡರ್ಗೆ headerVariables, ಮಾಧ್ಯಮವಲ್ಲದ ಹೆಡರ್ಗೆ headerMediaUrl ನೀಡಲಾಗಿದೆ |
| 422 | MEDIA_REQUIRED | ಟೆಂಪ್ಲೇಟ್ ಹೆಡರ್ ಚಿತ್ರ, ವೀಡಿಯೋ ಅಥವಾ ದಸ್ತಾವೇಜು, ಆದರೆ headerMediaUrl https ಲಿಂಕ್ ಅಲ್ಲ; ಅಥವಾ ಅದನ್ನು ನೀಡದಿದ್ದರೆ ಅನುಮೋದಿತ ಮಾಧ್ಯಮದ ಲಿಂಕ್ ಕೂಡ https ಅಲ್ಲ |
| 422 | TEMPLATE_NOT_SENDABLE | ಟೆಂಪ್ಲೇಟ್ API ಕಳುಹಿಸಲಾಗದ ವಿಷಯ ಕೇಳುತ್ತದೆ: ಸ್ಥಳದ ಹೆಡರ್, ಸ್ವಂತ ಮೌಲ್ಯವಿರುವ ಬಟನ್ ಅಥವಾ ಹೆಸರಿನ ಚರ |
| 422 | RECIPIENT_OPTED_OUT | ಮಾರ್ಕೆಟಿಂಗ್ ನಿರಾಕರಿಸಿದ ಸಂಖ್ಯೆಗೆ ಮಾರ್ಕೆಟಿಂಗ್ ಟೆಂಪ್ಲೇಟ್ |
| 422 | OUTSIDE_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ಸಿಗುತ್ತದೆ.
ಸಂದೇಶಗಳ ಪಟ್ಟಿ
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ಕಳುಹಿಸುವಾಗ ನೀಡಿದ ಮೌಲ್ಯಗಳು ಅಥವಾ{}.
ಸಂದೇಶ ಪಡೆಯುವುದು
ಕಳುಹಿಸುವಾಗ ಕೊಟ್ಟ 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ನ
statusqueued,sent,delivered,undeliveredಅಥವಾfailed. - WhatsApp ಸಂದೇಶದ ಸ್ಥಿತಿ
queued,sent,delivered,readಅಥವಾfailed, ಜೊತೆಗೆreadAt. ಅದರfailureCodeMetaದಾಗಿದ್ದು ಉದಾಹರಣೆಗೆmeta:131026. - ಇಮೇಲ್ನ ಸ್ಥಿತಿ ಕಳುಹಿಸುವವರೆಗೆ
queued, ನಂತರsent, ಕೆಲವು ಸ್ವೀಕರಿಸುವವರನ್ನು ಬಿಟ್ಟರೆpartially_suppressed, ಎಲ್ಲರನ್ನೂ ಬಿಟ್ಟರೆsuppressed, ಕಳುಹಿಸಲಾಗದಿದ್ದರೆfailed. ಪ್ರತಿ ಸ್ವೀಕರಿಸುವವರ ಸಮಯಗಳು ಇಮೇಲ್ ಪೂರೈಕೆದಾರರ ಈವೆಂಟ್ಗಳಿಂದ ಬರುತ್ತವೆ; ಆದ್ದರಿಂದ ಮೊದಲ ಈವೆಂಟ್ವರೆಗೆrecipientsಖಾಲಿಯಾಗಿರುತ್ತದೆ. metadataಕಳುಹಿಸುವಾಗ ನೀಡಿದ ಮೌಲ್ಯಗಳು ಅಥವಾ{}: ಮೆಟಾಡೇಟಾ ನೋಡಿ.
ಖಾತೆಗೆ ಸೇರದ ಅಥವಾ ಇಲ್ಲದ ಸಂದೇಶ 404 MESSAGE_NOT_FOUND ಕೊಡುತ್ತದೆ. ಎಂದೂ ಕಳುಹಿಸದ ಇಮೇಲ್ ಇಲ್ಲಿ 24 ಗಂಟೆಗಳ ನಂತರ ಸಿಗುವುದಿಲ್ಲ; ಪಟ್ಟಿಯಲ್ಲಿ ಉಳಿಯುತ್ತದೆ.
ವರದಿಯ ಸಾರಾಂಶ
ಒಂದು ಅವಧಿಯಲ್ಲಿ ಕಳುಹಿಸಲು ವಿನಂತಿಸಿದ ಸಂದೇಶಗಳ ಫಲಿತಾಂಶಗಳು, ಚಾನೆಲ್ ಮತ್ತು ಸ್ಥಿತಿಯಂತೆ ಎಣಿಕೆ; ಜೊತೆಗೆ ಎಷ್ಟು ಇಮೇಲ್ ತೆರೆಯಲಾಯಿತು, ಕ್ಲಿಕ್ ಮಾಡಲಾಯಿತು ಅಥವಾ ಸ್ಪ್ಯಾಮ್ ಎಂದು ಗುರುತಿಸಲಾಯಿತು.
- ಹೆಸರು
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 ಸಿಗುತ್ತದೆ.