API ਸੁਨੇਹੇ
ਆਪਣੀ ਸੰਸਥਾ ਵੱਲੋਂ ਈਮੇਲ, SMS ਅਤੇ WhatsApp ਸੁਨੇਹੇ ਭੇਜੋ, ਦਸਤਾਵੇਜ਼ ਵਿੱਚ ਦਿੱਤੀਆਂ ਸੰਭਾਲ ਹੱਦਾਂ ਅੰਦਰ ਮੁੜ ਕੋਸ਼ਿਸ਼ ਕਰਨ ਲਈ ਆਈਡੈਂਪੋਟੈਂਸੀ ਕੁੰਜੀ ਵਰਤੋ ਅਤੇ ਹਰ ਸੁਨੇਹੇ ਦਾ ਨਤੀਜਾ ਵੱਖਰੇ ਤੌਰ ਉੱਤੇ ਜਾਂ ਰਿਪੋਰਟ ਵਿੱਚ ਵੇਖੋ।
ਇਹ /external/v1 ਰੂਟ API ਕੁੰਜੀਆਂ ਵਰਤਦੇ ਹਨ। ਹਰ ਭੇਜਣ ਲਈ ਉਸ ਚੈਨਲ ਦੇ ਸਕੋਪ ਵਾਲੀ ਕੁੰਜੀ ਚਾਹੀਦੀ ਹੈ: email:send, sms:send ਜਾਂ whatsapp:send। ਸੁਨੇਹੇ ਅਤੇ ਰਿਪੋਰਟਾਂ ਪੜ੍ਹਨ ਲਈ messages:read ਚਾਹੀਦਾ ਹੈ। ਪ੍ਰਮਾਣੀਕਰਨ ਵੇਖੋ; OAuth ਐਕਸੈੱਸ ਟੋਕਨ API v2 ਵਰਤਦੇ ਹਨ।
ਸਫ਼ਲ ਭੇਜਣ ਦੀ ਬੇਨਤੀ ਆਮ ਤੌਰ ਉੱਤੇ 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 ਅੱਖਰ ਅਤੇ ਆਮ ASCII ਵਿੱਚ ਹੋਵੇ, ਜਦ ਤੱਕ ਟੈਂਪਲੇਟ Unicode ਨਾ ਹੋਵੇ।
- ਨਾਮ
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 ਮੀਡੀਆ ਹੈਡਰ ਨੂੰ ਚਿੱਤਰ, ਵੀਡੀਓ ਜਾਂ ਦਸਤਾਵੇਜ਼ ਦਿੰਦਾ ਹੈ; ਨਹੀਂ ਤਾਂ ਮਨਜ਼ੂਰ ਮੀਡੀਆ ਭੇਜਿਆ ਜਾਂਦਾ ਹੈ। API ਜੋ ਨਹੀਂ ਭੇਜ ਸਕਦੀ, ਜਿਵੇਂ ਸਥਾਨ ਹੈਡਰ, ਆਪਣੇ ਮੁੱਲ ਵਾਲਾ ਬਟਨ ਜਾਂ {{first_name}} ਵਰਗਾ ਨਾਮ ਵਾਲਾ ਵੇਰੀਏਬਲ, ਮੰਗਣ ਵਾਲਾ ਟੈਂਪਲੇਟ ਭੇਜਣ ਜਾਂ ਚਾਰਜ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ ਰੱਦ ਹੁੰਦਾ ਹੈ।
ਚਿੱਤਰ ਹੈਡਰ ਵਾਲਾ ਟੈਂਪਲੇਟ
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 ਹੈਡਰ ਦਿਓ, ਆਪਣੀ ਪਸੰਦ ਦੇ 1 ਤੋਂ 255 ਅੱਖਰ, ਜਿਵੇਂ ਆਰਡਰ ਜਾਂ ਇਵੈਂਟ ID। ਸਮਾਂ ਮੁੱਕ ਜਾਵੇ ਜਾਂ ਪਤਾ ਨਾ ਹੋਵੇ ਕਿ ਬੇਨਤੀ ਸਵੀਕਾਰ ਹੋਈ ਹੈ ਜਾਂ ਨਹੀਂ, ਤਾਂ ਉਸੇ ਕੁੰਜੀ ਅਤੇ ਮੁੱਖ ਭਾਗ ਨਾਲ ਮੁੜ ਭੇਜੋ। ਦੁਹਰਾਵਾ ਰੋਕਣਾ ਸੰਭਾਲੀ ਕੁੰਜੀ ਦੀ ਸਥਿਤੀ ਉੱਤੇ ਨਿਰਭਰ ਹੈ, ਹਰ ਮੁੜ ਆਈ ਬੇਨਤੀ ਵਿਰੁੱਧ ਸਥਾਈ ਗਾਰੰਟੀ ਨਹੀਂ:
- ਉਹੀ ਭੇਜਣ ਦੀ ਬੇਨਤੀ ਮੁੜ ਕਰਨ ਉੱਤੇ
202ਅਤੇ ਪਹਿਲੇ ਸੁਨੇਹੇ ਦਾ ID ਮਿਲਦਾ ਹੈ ਅਤੇ ਕੁਝ ਵੀ ਦੋ ਵਾਰ ਨਹੀਂ ਭੇਜਿਆ ਜਾਂਦਾ। - ਉਹੀ ਕੁੰਜੀ ਪਰ ਵੱਖਰਾ ਸੁਨੇਹਾ, ਉਸ ਦੇ
metadataਸਮੇਤ,409 IDEMPOTENCY_CONFLICTਨਾਲ ਰੱਦ ਹੁੰਦਾ ਹੈ ਅਤੇ ਕਤਾਰ ਵਿੱਚ ਕੁਝ ਨਹੀਂ ਜਾਂਦਾ। - ਕੁੰਜੀ ਕਿੰਨਾ ਚਿਰ ਰਹਿੰਦੀ ਹੈ: ਈਮੇਲ ਅਤੇ WhatsApp ਦੀ ਕੁੰਜੀ ਦੀ ਸਥਿਤੀ Redis ਵਿੱਚ 24 ਘੰਟੇ ਰਹਿੰਦੀ ਹੈ; ਕੈਸ਼ ਗੁਆਚਣ ਜਾਂ ਮਿਆਦ ਮੁੱਕਣ ਉੱਤੇ ਦੁਹਰਾਵਾ ਰੋਕਣ ਦੀ ਸਥਿਤੀ ਮਿਟ ਜਾਂਦੀ ਹੈ ਅਤੇ ਉਹੀ ਕੁੰਜੀ ਮੁੜ ਭੇਜ ਸਕਦੀ ਹੈ। ਸੰਭਾਲੇ ਸੁਨੇਹੇ ਦੇ ਰਿਕਾਰਡ ਵਿੱਚ SMS ਕੁੰਜੀ ਦੀ ਸਮੇਂ ਅਧਾਰਿਤ ਮਿਆਦ ਨਹੀਂ: ਬਾਅਦ ਦੇ SMS ਲਈ ਆਪਣੀ ਵੱਖਰੀ ਕੁੰਜੀ ਚਾਹੀਦੀ ਹੈ। ਇਹ ਹੱਦਾਂ ਪਹੁੰਚਣ ਦੀ ਗਾਰੰਟੀ ਨਹੀਂ ਹਨ।
- ਕੁੰਜੀਆਂ ਤੁਹਾਡੀ ਸੰਸਥਾ ਦੀਆਂ ਹਨ, ਹਰ ਚੈਨਲ ਦਾ ਇੱਕ ਸੈੱਟ ਹੈ, ਇਸ ਲਈ ਇੱਕੋ ਕੁੰਜੀ ਈਮੇਲ ਅਤੇ SMS ਲਈ ਵਰਤੀ ਜਾ ਸਕਦੀ ਹੈ।
X-Oblic-On-Behalf-Ofਹੇਠ ਉਹ ਉਪ-ਖਾਤੇ ਦੀਆਂ ਹੁੰਦੀਆਂ ਹਨ। - ਮੁੜ ਕੋਸ਼ਿਸ਼ ਦੀ ਫਿਰ ਜਾਂਚ ਹੁੰਦੀ ਹੈ, ਮਿਲਾਣ ਤੋਂ ਪਹਿਲਾਂ: ਜਿਸ ਈਮੇਲ ਦਾ ਭੇਜਣ ਵਾਲਾ ਹੁਣ ਤਸਦੀਕਸ਼ੁਦਾ ਨਹੀਂ, ਜਾਂ ਜਿਸ WhatsApp ਜਵਾਬ ਦੇ 24 ਘੰਟੇ ਲੰਘ ਚੁੱਕੇ ਹਨ, ਉਸ ਨੂੰ ਪਹਿਲਾ 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 ਦਿੰਦਾ ਹੈ।