Действие CreatePlatformEndpoint
Статья создана
Обновлена 13 июня 2024 г.
Создает эндпоинт для Push-уведомлений (подписывает пользователя на Push-уведомления).
HTTP-запрос
POST https://notifications.yandexcloud.net/
Query-параметры
| Параметр | Описание |
|---|---|
Action |
string Обязательное поле. Параметр для обозначения типа операции. Значение: CreatePlatformEndpoint. |
PlatformApplicationArn |
string Обязательное поле. Идентификатор канала мобильных Push-уведомлений. Пример: arn:aws:sns::aoegtvhtp8ob********:app/GCM/test-cns-9990. |
Attributes.entry.N.key |
string Обязательное поле. Ключ атрибута. N — числовое значение.Пример: Attributes.entry.1.key=Token&Attributes.entry.2.key=CustomUserData. |
Attributes.entry.N.value |
string Обязательное поле. Значение атрибута. N — числовое значение.Пример: Attributes.entry.1.value=c8gzjriSVxDDzX2fAV********&Attributes.entry.2.value=test-text. |
ResponseFormat |
string Формат ответа. Возможные значения:
|
Атрибуты
| Атрибут | Описание |
|---|---|
Token |
string Обязательное поле. Уникальный токен на устройстве пользователя (Registration ID), созданный сервисом уведомлений для приложения. |
CustomUserData |
string Прочие пользовательские данные, которые можно сохранить вместе с эндпоинтом. Cloud Notification Service никак не использует эти данные. |
Примечание
Атрибут Enabled (включение и выключение уведомлений в эндпоинт) в настоящее время не поддерживается.
Ответ
Успешный ответ
При отсутствии ошибок Cloud Notification Service отвечает HTTP-кодом 200.
Успешный ответ содержит дополнительные данные в формате XML или JSON в зависимости от указанного параметра ResponseFormat.
Схема данных:
XML
JSON
<?xml version="1.0" encoding="UTF-8"?>
<CreatePlatformEndpointResponse>
<ResponseMetadata>
<RequestId>string</RequestId>
</ResponseMetadata>
<EndpointArn>string</EndpointArn>
</CreatePlatformEndpointResponse>
{
"ResponseMetadata": {
"RequestId": "string"
},
"EndpointArn": "string"
}
Где:
RequestId— идентификатор запроса.EndpointArn— идентификатор (ARN) мобильного эндпоинта.
Ответ с ошибкой
При возникновении ошибки Cloud Notification Service отвечает сообщением с соответствующим HTTP-кодом.
Перечень общих кодов ошибок для всех действий см. в разделе Ошибки.