কাকাও এপিআই

createKakaoMessage

ব্যবহারকারীদের কাকাও বার্তা পাঠাতে ব্যবহৃত হয়।

POST https://api.pushwoosh.com/json/1.3/createKakaoMessage

পূর্বশর্ত

এই এন্ডপয়েন্টটি ব্যবহার করার আগে, নিশ্চিত করুন:

কাকাও প্ল্যাটফর্ম কনফিগার করা আছে: আপনার Pushwoosh অ্যাপ্লিকেশনে অবশ্যই কাকাও ক্রেডেনশিয়াল কনফিগার করা থাকতে হবে। আরও জানুন
টেমপ্লেট অনুমোদিত: কাকাও টেমপ্লেট ব্যবহার করার আগে অবশ্যই তৈরি এবং অনুমোদিত হতে হবে। আরও জানুন
ডিভাইস নিবন্ধিত: কাকাও এন্ডপয়েন্ট হিসাবে স্বীকৃত হওয়ার জন্য ডিভাইসগুলিকে অবশ্যই kakao: উপসর্গ দিয়ে নিবন্ধিত করতে হবে।

রিকোয়েস্ট বডি

নাম	প্রয়োজনীয়	টাইপ	বিবরণ
auth*	হ্যাঁ	string	Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
application*	হ্যাঁ	string	Pushwoosh অ্যাপ্লিকেশন কোড
notifications*	হ্যাঁ	array	নোটিফিকেশন অবজেক্টের অ্যারে। নিচে বিস্তারিত দেখুন।

নোটিফিকেশন প্যারামিটার

নাম	প্রয়োজনীয়	টাইপ	বিবরণ
send_date*	হ্যাঁ	string	বার্তা পাঠানোর তারিখ এবং সময়। অবিলম্বে পাঠাতে `YYYY-MM-DD HH:MM:SS` (UTC) ফরম্যাট বা `"now"` ব্যবহার করুন। সমস্ত সময় UTC হিসাবে ব্যাখ্যা করা হয়।
devices*	`users` প্রদান করা না হলে প্রয়োজনীয়	array[string]	ডিভাইস টোকেনের তালিকা। প্রতিটি টোকেনের আগে অবশ্যই `kakao:` উপসর্গ থাকতে হবে (যেমন, `"kakao:user_token"`)।
users*	`devices` প্রদান করা না হলে প্রয়োজনীয়	array[string]	টার্গেট করার জন্য ইউজার আইডির তালিকা।
template*	হ্যাঁ	string	কাকাও টেমপ্লেটের নাম। অবশ্যই একটি পূর্ব-অনুমোদিত টেমপ্লেট হতে হবে। আরও জানুন
kakao_content_variables	না	object	টেমপ্লেট ভেরিয়েবল প্রতিস্থাপনের জন্য কী-ভ্যালু পেয়ার। কীগুলি আপনার কাকাও টেমপ্লেটে সংজ্ঞায়িত ভেরিয়েবলের সাথে মিলতে হবে। ঐচ্ছিক কিন্তু আপনার কাকাও বার্তাগুলির ডাইনামিক ব্যক্তিগতকরণের অনুমতি দেয়।

নিষিদ্ধ প্যারামিটার

এই এন্ডপয়েন্টের জন্য নিম্নলিখিত প্যারামিটারগুলি অনুমোদিত নয় এবং এর ফলে একটি ভ্যালিডেশন ত্রুটি হবে:

platforms: প্ল্যাটফর্ম স্বয়ংক্রিয়ভাবে কাকাওতে সেট করা হয়
filter: ডিভাইস ফিল্টারিং সমর্থিত নয়
filter_code: ফিল্টার কোড সমর্থিত নয়
conditions: শর্তসাপেক্ষ টার্গেটিং সমর্থিত নয়

রিকোয়েস্টের উদাহরণ

{
  "request": {
    "auth": "your-api-access-token",        // প্রয়োজনীয়। Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
    "application": "XXXXX-XXXXX",           // প্রয়োজনীয়। Pushwoosh অ্যাপ্লিকেশন কোড।
    "notifications": [
      {
        "send_date": "now",                 // প্রয়োজনীয়। YYYY-MM-DD HH:MM:SS (UTC) অথবা "now"।
        "devices": ["kakao:user123@kakao.com", "kakao:device_abc"],  // users প্রদান করা না হলে প্রয়োজনীয়। kakao: উপসর্গ সহ ডিভাইস টোকেন।
        "users": ["user_001", "user_002"],  // devices প্রদান করা না হলে প্রয়োজনীয়। টার্গেট করার জন্য ইউজার আইডি।
        "template": "welcome_message",      // প্রয়োজনীয়। কাকাও টেমপ্লেটের নাম (অবশ্যই পূর্ব-অনুমোদিত হতে হবে)।
        "kakao_content_variables": {        // ঐচ্ছিক। টেমপ্লেট ভেরিয়েবল প্রতিস্থাপন।
          "user_name": "John Doe",
          "order_number": "12345"
        }
      }
    ]
  }
}

রেসপন্সের উদাহরণ

{
  "status_code": 200,
  "response": {
    "Messages": ["MESSAGE_ID_1"],
    "Warnings": [],
    "UnknownDevices": {},
    "UnknownUsers": {},
    "FailedDevices": {},
    "UnknownPhoneNumbers": {}
  }
}

ফিল্ড	টাইপ	বিবরণ
`Messages`	array[string]	ট্র্যাকিংয়ের জন্য তৈরি করা বার্তা আইডিগুলির অ্যারে
`Warnings`	array	প্রসেসিংয়ের সময় তৈরি হওয়া যেকোনো সতর্কতা
`UnknownDevices`	object	যে ডিভাইসগুলি খুঁজে পাওয়া যায়নি
`UnknownUsers`	object	যে ইউজার আইডিগুলি সমাধান করা যায়নি
`FailedDevices`	object	প্রসেসিংয়ের সময় ব্যর্থ হওয়া ডিভাইসগুলি
`UnknownPhoneNumbers`	object	যে ফোন নম্বরগুলি খুঁজে পাওয়া যায়নি

{
  "status_code": 210,
  "status_message": "Error description"
}

সাধারণ ত্রুটির বার্তা

ত্রুটির বার্তা	কারণ
`Missing required parameter: send_date`	নোটিফিকেশনে `send_date` ফিল্ডটি প্রদান করা হয়নি
`Missing required parameter: devices or users`	`devices` বা `users` কোনো অ্যারে প্রদান করা হয়নি
`Invalid Kakao devices list`	এক বা একাধিক ডিভাইস টোকেনে `kakao:` উপসর্গটি নেই
`Invalid parameter: platforms`	ম্যানুয়ালি প্ল্যাটফর্ম সেট করার চেষ্টা করা হয়েছে (অনুমোদিত নয়)
`Kakao template is required`	টেমপ্লেটের নাম প্রদান করা হয়নি
`Invalid Kakao template`	নির্দিষ্ট টেমপ্লেটটির অস্তিত্ব নেই
`Kakao template not approved`	টেমপ্লেটটি বিদ্যমান কিন্তু কাকাও দ্বারা অনুমোদিত নয়
`Please configure Kakao platform`	অ্যাপ্লিকেশনে কাকাও ক্রেডেনশিয়াল কনফিগার করা নেই

{
  "status_code": 500,
  "status_message": "Internal server error"
}

কোডের উদাহরণ

curl -X POST "https://api.pushwoosh.com/json/1.3/createKakaoMessage" \
  -H "Content-Type: application/json" \
  -d '{
    "request": {
      "auth": "your-api-access-token",
      "application": "XXXXX-XXXXX",
      "notifications": [
        {
          "send_date": "now",
          "devices": ["kakao:user123@kakao.com", "kakao:device_abc"],
          "template": "welcome_message",
          "kakao_content_variables": {
            "user_name": "John Doe",
            "order_number": "12345"
          }
        }
      ]
    }
  }'

<?php
$url = 'https://api.pushwoosh.com/json/1.3/createKakaoMessage';

$data = [
    'request' => [
        'auth' => 'your-api-access-token',
        'application' => 'XXXXX-XXXXX',
        'notifications' => [
            [
                'send_date' => 'now',
                'devices' => ['kakao:user123@kakao.com', 'kakao:device_abc'],
                'template' => 'welcome_message',
                'kakao_content_variables' => [
                    'user_name' => 'John Doe',
                    'order_number' => '12345'
                ]
            ]
        ]
    ]
];

$options = [
    'http' => [
        'header'  => "Content-Type: application/json\r\n",
        'method'  => 'POST',
        'content' => json_encode($data)
    ]
];

$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
echo $result;

import requests

url = "https://api.pushwoosh.com/json/1.3/createKakaoMessage"

payload = {
    "request": {
        "auth": "your-api-access-token",
        "application": "XXXXX-XXXXX",
        "notifications": [
            {
                "send_date": "now",
                "devices": ["kakao:user123@kakao.com", "kakao:device_abc"],
                "template": "welcome_message",
                "kakao_content_variables": {
                    "user_name": "John Doe",
                    "order_number": "12345"
                }
            }
        ]
    }
}

response = requests.post(url, json=payload)
print(response.json())

উদাহরণ: ডিভাইসের পরিবর্তে ব্যবহারকারীদের কাছে পাঠানো

{
  "request": {
    "auth": "your-api-access-token",
    "application": "XXXXX-XXXXX",
    "notifications": [
      {
        "send_date": "now",
        "users": ["user_001", "user_002", "user_003"],
        "template": "promotion_alert",
        "kakao_content_variables": {
          "discount_percent": "20",
          "promo_code": "SAVE20"
        }
      }
    ]
  }
}

উদাহরণ: নির্ধারিত বার্তা

{
  "request": {
    "auth": "your-api-access-token",
    "application": "XXXXX-XXXXX",
    "notifications": [
      {
        "send_date": "2024-12-25 09:00:00",
        "devices": ["kakao:user123"],
        "template": "holiday_greeting"
      }
    ]
  }
}