# Kakao API

import { Badge } from '@astrojs/starlight/components';

<Aside type="caution" title="/createKakaoMessage устарел">
Новым интеграциям следует использовать [Messaging API v2](/ru/developer/api-reference/messaging-api-v2/) — передайте `platforms: ["KAKAO"]` в `Notify` и используйте блок `kakao` внутри `payload.content.localized_content`. См. [руководство по миграции](/ru/developer/api-reference/messaging-api-v2/migration-from-v1/#from-createkakaomessage).
</Aside>

## createKakaoMessage <Badge text="Устарел" variant="caution" size="small" />

Используйте эту конечную точку для отправки сообщений Kakao пользователям.

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

<Aside type="note">
Эта конечная точка предназначена только для обмена сообщениями Kakao. Для многоканального обмена сообщениями используйте [`/createMessage`](/ru/developer/api-reference/messages-api/).
</Aside>

### Предварительные условия

Перед использованием этой конечной точки убедитесь, что:

1. **Платформа Kakao настроена**: В вашем приложении Pushwoosh должны быть настроены учетные данные Kakao. [Узнать больше](/ru/developer/first-steps/connect-messaging-services/kakao-configuration/)

2. **Шаблоны одобрены**: Шаблоны Kakao должны быть созданы и одобрены перед их использованием. [Узнать больше](/ru/product/content/kakao-presets/)

3. **Устройства зарегистрированы**: Устройства должны быть зарегистрированы с префиксом `kakao:`, чтобы распознаваться как конечные точки Kakao.

### Тело запроса

| Имя <div style="width:180px"></div> | Обязательный <div style="width:100px"></div> | Тип | Описание |
| :---- | :---- | :---- | :---- |
| auth\* | Да | string | [Токен доступа API](/ru/developer/api-reference/api-identifiers/#api-access-token) из Панели управления Pushwoosh. |
| application\* | Да | string | [Код приложения Pushwoosh](/ru/developer/api-reference/api-identifiers/#application-code) |
| notifications\* | Да | array | Массив объектов уведомлений. Подробности см. ниже. |

### Параметры уведомления

| Имя <div style="width:180px"></div> | Обязательный | Тип | Описание |
| :---- | :---- | :---- | :---- |
| send_date* | Да | string | Дата и время отправки сообщения. Используйте формат `YYYY-MM-DD HH:MM:SS` (UTC) или `"now"` для немедленной отправки. Все значения времени интерпретируются как UTC. |
| devices* | Обязателен, если `users` не указан | array[string] | Список токенов устройств. Каждый токен **должен** иметь префикс `kakao:` (например, `"kakao:user_token"`). |
| users* | Обязателен, если `devices` не указан | array[string] | Список User ID для таргетинга. |
| template* | Да | string | Имя шаблона Kakao. Должен быть предварительно одобренным шаблоном. [Узнать больше](/ru/product/content/kakao-presets/) |
| kakao_content_variables | Нет | object | Пары ключ-значение для подстановки переменных в шаблон. Ключи должны соответствовать переменным, определенным в вашем шаблоне Kakao. Необязательный параметр, но позволяет динамически персонализировать ваши сообщения Kakao. |

<Aside type="caution" title="Важно">
Вы должны указать либо `devices`, либо `users`. Не оставляйте оба поля пустыми.
</Aside>

#### Запрещенные параметры

Следующие параметры не допускаются для этой конечной точки и приведут к ошибке валидации:

- `platforms`: Платформа автоматически устанавливается как Kakao
- `filter`: Фильтрация устройств не поддерживается
- `filter_code`: Коды фильтров не поддерживаются
- `conditions`: Условный таргетинг не поддерживается

### Пример запроса

```json
{
  "request": {
    "auth": "your-api-access-token",        // обязательный. Токен доступа API из Панели управления Pushwoosh.
    "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 не указан. User ID для таргетинга.
        "template": "welcome_message",      // обязательный. Имя шаблона Kakao (должен быть предварительно одобрен).
        "kakao_content_variables": {        // необязательный. Подстановка переменных в шаблон.
          "user_name": "John Doe",
          "order_number": "12345"
        }
      }
    ]
  }
}
```

### Пример ответа

<Tabs>
<TabItem label="200">

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

| Поле | Тип | Описание |
|-------|------|-------------|
| `Messages` | array[string] | Массив ID сообщений, созданных для отслеживания |
| `Warnings` | array | Любые предупреждения, сгенерированные во время обработки |
| `UnknownDevices` | object | Устройства, которые не удалось найти |
| `UnknownUsers` | object | User ID, которые не удалось разрешить |
| `FailedDevices` | object | Устройства, обработка которых завершилась сбоем |
| `UnknownPhoneNumbers` | object | Номера телефонов, которые не удалось найти |

</TabItem>

<TabItem label="210">

```json
{
  "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` | Шаблон существует, но не одобрен Kakao |
| `Please configure Kakao platform` | В приложении не настроены учетные данные Kakao |

</TabItem>

<TabItem label="500">

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

</TabItem>
</Tabs>

### Примеры кода

<Tabs>
<TabItem label="cURL">

```bash
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"
          }
        }
      ]
    }
  }'
```

</TabItem>

<TabItem label="PHP">

```php
<?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;
```

</TabItem>

<TabItem label="Python">

```python
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())
```

</TabItem>
</Tabs>

### Пример: отправка пользователям вместо устройств

```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"
        }
      }
    ]
  }
}
```

### Пример: запланированное сообщение

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