Oblic

ਟੈਂਪਲੇਟ

ਖਾਤਾ ਜਿਨ੍ਹਾਂ ਨਾਲ ਭੇਜਦਾ ਹੈ ਉਹ ਟੈਂਪਲੇਟ ਸੰਭਾਲੋ: ਈਮੇਲ ਟੈਂਪਲੇਟ, SMS ਹੈਡਰ ਅਤੇ DLT ਟੈਂਪਲੇਟ, ਅਤੇ WhatsApp ਨੰਬਰ ਤੇ ਟੈਂਪਲੇਟ। ਪੜ੍ਹਨ ਲਈ ਚੈਨਲ ਦਾ ਭੇਜਣ ਵਾਲਾ ਸਕੋਪ ਜਾਂ templates:manage ਲੋੜੀਂਦਾ ਹੈ; ਤਬਦੀਲੀ ਲਈ templates:manage ਵਾਲੀ Owner ਜਾਂ Admin ਕੁੰਜੀ ਲੋੜੀਂਦੀ ਹੈ।


ਈਮੇਲ ਟੈਂਪਲੇਟ

ਖਾਤੇ ਦੇ ਈਮੇਲ ਟੈਂਪਲੇਟ ਉਸਦੇ ਡਿਫਾਲਟ ਵਰਕਸਪੇਸ ਦੇ ਹਨ, ਜਿੱਥੇ API ਸੁਨੇਹੇ ਰਹਿੰਦੇ ਹਨ ਅਤੇ ਡੈਸ਼ਬੋਰਡ ਉਨ੍ਹਾਂ ਨੂੰ ਦਿਖਾਉਂਦਾ ਹੈ। API ਰਾਹੀਂ ਬਣਿਆ ਟੈਂਪਲੇਟ HTML ਹੈ, ਜਿਸਦੇ {{name}} ਪਲੇਸਹੋਲਡਰ ਭੇਜਣ ਵੇਲੇ ਭਰੇ ਜਾਂਦੇ ਹਨ। ਡੈਸ਼ਬੋਰਡ ਐਡੀਟਰ ਵਿੱਚ ਡਿਜ਼ਾਈਨ ਕੀਤਾ ਟੈਂਪਲੇਟ ਪੜ੍ਹਿਆ, ਭੇਜਣ ਲਈ ਵਰਤਿਆ ਅਤੇ ਮਿਟਾਇਆ ਜਾ ਸਕਦਾ ਹੈ, ਪਰ ਬਦਲਿਆ ਨਹੀਂ ਜਾ ਸਕਦਾ, ਤਾਂ ਜੋ ਉਸਦਾ HTML ਅਤੇ ਡਿਜ਼ਾਈਨ ਵੱਖ ਨਾ ਹੋਣ।

ਤਰੀਕਾਪਾਥਕੰਮ
GET/external/v1/templatesਨਵੇਂ ਤੋਂ ਪੁਰਾਣੇ ਕ੍ਰਮ ਵਿੱਚ ਟੈਂਪਲੇਟ, ਉਨ੍ਹਾਂ ਦੇ HTML ਤੋਂ ਬਿਨਾਂ
GET/external/v1/templates/{id}ਇੱਕ ਟੈਂਪਲੇਟ, ਉਸਦੇ HTML ਅਤੇ ਸਵੀਕਾਰਯੋਗ ਵੇਰੀਏਬਲਾਂ ਸਮੇਤ
POST/external/v1/templatesHTML ਤੋਂ ਟੈਂਪਲੇਟ ਬਣਾਉਂਦਾ ਹੈ: 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-ਐਸਕੇਪ ਹੁੰਦੇ ਹਨ; ਇਸ ਨਾਲ ਟੈਂਪਲੇਟ ਦਾ HTML ਸਾਫ਼ ਜਾਂ ਸੈਂਡਬਾਕਸ ਵਿੱਚ ਵੱਖ ਨਹੀਂ ਹੁੰਦਾ।

ਟੈਂਪਲੇਟ ਬਣਾਉਣਾ

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 ਦੇ ਪਲੇਸਹੋਲਡਰਾਂ ਨੂੰ ਵੱਡੇ-ਛੋਟੇ ਅੱਖਰਾਂ ਦਾ ਫ਼ਰਕ ਕੀਤੇ ਬਿਨਾਂ, ਪਹਿਲੀ ਵਾਰ ਆਉਣ ਦੇ ਕ੍ਰਮ ਅਤੇ ਲਿਖਤ ਵਿੱਚ ਦਿਖਾਉਂਦਾ ਹੈ।
  • kind API ਤੋਂ ਬਣੇ ਟੈਂਪਲੇਟ ਲਈ html ਅਤੇ ਡੈਸ਼ਬੋਰਡ ਐਡੀਟਰ ਤੋਂ ਬਣੇ ਲਈ designed ਹੈ। ਵਿਸ਼ਾ ਨਾ ਹੋਵੇ ਤਾਂ ਭੇਜਣ ਵੇਲੇ ਦਿਓ; ਕਿਸਮ ਵਾਪਸ ਆਏ ਵਿਸ਼ੇ ਦੀ ਜਾਂਚ ਦਾ ਬਦਲ ਨਹੀਂ ਹੈ।
  • ਡੈਸ਼ਬੋਰਡ ਦੇ ਮੈਂਸ਼ਨ, ਜਿਵੇਂ @unsubscribe ਜਾਂ @organizationName, ਸਿਰਫ਼ ਮੁਹਿੰਮਾਂ ਅਤੇ ਆਟੋਮੇਸ਼ਨ ਹਰ ਪ੍ਰਾਪਤਕਰਤਾ ਲਈ ਭਰਦੀਆਂ ਹਨ। ਅਜਿਹਾ ਮੈਂਸ਼ਨ ਰੱਖਣ ਵਾਲੇ ਟੈਂਪਲੇਟ ਨਾਲ ਭੇਜਣਾ ਰੱਦ ਹੁੰਦਾ ਹੈ।
  • ਸੂਚੀ cursor ਅਤੇ limit ਰਾਹੀਂ ਪੰਨਿਆਂ ਵਿੱਚ ਵੰਡੀ ਜਾਂਦੀ ਹੈ: ਡਿਫਾਲਟ ਪ੍ਰਤੀ ਪੰਨਾ 25, ਹੱਦ 1 ਤੋਂ 100, ਜਿਵੇਂ ਪੰਨਾ-ਵੰਡ ਵਿੱਚ ਦੱਸਿਆ ਹੈ। ਵਾਪਸ ਆਏ ਕਰਸਰ ਨੂੰ ਅਪਾਰਦਰਸ਼ੀ ਮੁੱਲ ਸਮਝੋ।
ਇਨਕਾਰcdਕਦੋਂ
400TEMPLATE_TOO_LARGEHTML 65,535 ਬਾਈਟ ਤੋਂ ਵੱਧ ਹੈ
404TEMPLATE_NOT_FOUNDਖਾਤੇ ਵਿੱਚ ਉਸ ID ਦਾ ਟੈਂਪਲੇਟ ਨਹੀਂ ਹੈ
409TEMPLATE_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ਕਦੋਂ
400INVALID_TEMPLATEਹੈਡਰ ਕਿਸਮ ਨਾਲ ਨਹੀਂ ਮਿਲਦਾ, 30 ਤੋਂ ਵੱਧ ਵੇਰੀਏਬਲ ਹਨ ਜਾਂ variableKeys ਹਰ ਇੱਕ ਦਾ ਨਾਮ ਠੀਕ ਇੱਕ ਵਾਰ ਨਹੀਂ ਦਿੰਦਾ
403REGISTRY_NOT_ALLOWEDਖਾਤਾ ਆਪਣੇ SMS ਰਜਿਸਟਰ ਨਹੀਂ ਕਰਦਾ
404TEMPLATE_NOT_FOUND, SENDER_NOT_FOUND, ACCOUNT_NOT_FOUNDਅਜਿਹਾ ਟੈਂਪਲੇਟ, ਹੈਡਰ ਜਾਂ ਉਪ-ਖਾਤਾ ਨਹੀਂ ਹੈ
409TEMPLATE_EXISTSਉਸ DLT ID ਦਾ ਟੈਂਪਲੇਟ ਪਹਿਲਾਂ ਹੀ ਰਜਿਸਟਰ ਹੈ
409SENDER_IN_USEਟੈਂਪਲੇਟਾਂ ਵੱਲੋਂ ਵਰਤਿਆ ਹੈਡਰ ਮਿਟਾਉਣਾ
422SENDER_NOT_ALLOWEDਹੈਡਰ ਖਾਤੇ ਦਾ ਨਹੀਂ ਹੈ
422MESSAGE_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/templatesMeta ਨੂੰ ਸਮੀਖਿਆ ਲਈ ਟੈਂਪਲੇਟ ਦਿੰਦਾ ਹੈ: 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"]] }
      }
    ]
  }'
  • ਟੈਂਪਲੇਟ ਦਾ status Meta ਦੀ ਸਟੋਰ ਕੀਤੀ ਸਮੀਖਿਆ ਸਥਿਤੀ ਹੈ, ਜਿਵੇਂ PENDING, APPROVED ਜਾਂ REJECTED; rejectionReason ਗੈਰਹਾਜ਼ਰ ਹੋ ਸਕਦਾ ਹੈ। 201 ਦਾ ਅਰਥ ਜਮ੍ਹਾਂ ਕੀਤਾ ਗਿਆ, ਮਨਜ਼ੂਰ ਨਹੀਂ। ਸਿਰਫ਼ APPROVED ਟੈਂਪਲੇਟ ਭੇਜੇ ਜਾ ਸਕਦੇ ਹਨ। ਸਮੀਖਿਆ ਪੂਰੀ ਹੋਣ ਦੀ ਸਮਾਂ-ਸੀਮਾ ਦਾ ਵਾਅਦਾ ਨਹੀਂ।
  • ਪ੍ਰਾਪਤਕਰਤਾ ਦਾ ਜਵਾਬ number, optedOut, ਕਦੋਂ ਅਤੇ ਕਿਵੇਂ (optedOutAt, optOutSource), lastInboundAt ਅਤੇ sessionOpenUntil ਦਿੰਦਾ ਹੈ: ਵਿਅਕਤੀ ਦੇ ਆਖਰੀ ਆਏ ਸੁਨੇਹੇ ਤੋਂ ਮਾਪਿਆ 24 ਘੰਟਿਆਂ ਦਾ ਸਮਾਂ। optedOut ਮਾਰਕੀਟਿੰਗ ਲਈ ਹੈ, ਹਰ ਸੁਨੇਹੇ ਲਈ ਨਹੀਂ। ਆਏ ਸੁਨੇਹਿਆਂ ਦਾ ਇਤਿਹਾਸ ਨਾ ਹੋਵੇ ਤਾਂ lastInboundAt ਅਤੇ sessionOpenUntil null ਹਨ। ਸਿਰਫ਼ ਸੈਸ਼ਨ ਦਾ ਟਾਈਮਸਟੈਂਪ ਭੇਜਣਾ ਸਵੀਕਾਰ ਹੋਣ ਦੀ ਗਾਰੰਟੀ ਨਹੀਂ; ਹੋਰ ਜਾਂਚਾਂ ਵੀ ਲਾਗੂ ਹਨ।
ਇਨਕਾਰcdਕਦੋਂ
409TEMPLATE_EXISTSਖਾਤੇ ਵਿੱਚ ਉਸ ਨਾਮ ਅਤੇ ਭਾਸ਼ਾ ਦਾ ਟੈਂਪਲੇਟ ਹੈ
422WHATSAPP_NOT_CONNECTEDਜੁੜੇ ਨੰਬਰ ਤੋਂ ਬਿਨਾਂ ਟੈਂਪਲੇਟ ਜਮ੍ਹਾਂ ਕਰਨਾ
422TEMPLATE_NAME_TOO_LONGਨਾਮ Meta ਲਈ ਬਹੁਤ ਲੰਮਾ ਹੈ
422TEMPLATE_REFUSEDMeta ਨੇ ਟੈਂਪਲੇਟ ਰੱਦ ਕੀਤਾ; ਆਮ ਸਥਾਨਕੀਕ੍ਰਿਤ ਇਨਕਾਰ, Meta ਦਾ ਮੂਲ ਜਵਾਬੀ ਪਾਠ ਨਹੀਂ
422INVALID_NUMBERਪ੍ਰਾਪਤਕਰਤਾ ਦਾ ਨੰਬਰ ਅੰਤਰਰਾਸ਼ਟਰੀ ਰੂਪ ਵਿੱਚ ਨਹੀਂ ਹੈ
502WHATSAPP_CODE_REFUSED, WHATSAPP_SUBSCRIBE_REFUSED, WHATSAPP_REGISTER_REFUSEDMeta ਨੇ ਨੰਬਰ ਜੋੜਨ ਦਾ ਕੋਈ ਕਦਮ ਰੱਦ ਕੀਤਾ
503WHATSAPP_UNAVAILABLEਜੋੜਨ ਦੇ ਕਿਸੇ ਕਦਮ ਦੌਰਾਨ Meta ਤੱਕ ਨਹੀਂ ਪਹੁੰਚਿਆ ਜਾ ਸਕਿਆ
ਕੀ ਇਹ ਪੰਨਾ ਮਦਦਗਾਰ ਸੀ?