[Документация Yandex Cloud](../../index.md) > [Yandex Cloud Notification Service](../index.md) > [Справочник API](index.md) > Publish # Действие Publish Отправляет [Push-уведомление](../concepts/push.md) в [эндпоинт](../concepts/index.md#mobile-endpoints) или [SMS](../concepts/sms.md) на телефонный номер. ## HTTP-запрос {#request} ```http POST https://notifications.yandexcloud.net/ ``` ### Query-параметры {#parameters} Параметр | Описание --- | --- `Action` | **string**
Обязательное поле.
Параметр для обозначения типа операции.
Значение: `Publish`. `Message` | **string**
Обязательное поле.
Сообщение, которое вы хотите отправить в эндпоинт.
Возможные форматы:
В формате JSON вы можете опционально передать текст для конкретной мобильной платформы, например:
`{ "default": "Default message", "APNS": "{"aps":{"alert": "Check out these awesome deals!","url":"yandex.cloud"} }", "GCM": "{"data":{"message":"Check out these awesome deals!","url":"yandex.cloud"},"notification":{"title":"GCM notification title"}}" "HMS": "{"data":{"message":"Check out these awesome deals!","url":"yandex.cloud"},"notification":{"title":"HMS notification title"}}" }`
В сообщениях для платформ FCM и HMS обязательно должно присутствовать хотя бы одно из полей `data` или `notification`. `MessageStructure` | **string**
Если в поле `Message` вы передаете сообщение в формате JSON, задайте в поле `MessageStructure` значение `json`. `MessageAttributes.entry.N.key` | **string**
Обязательное поле.
Ключ [атрибута](#attributes). `N` — числовое значение.
Пример: `MessageAttributes.entry.1.key=AWS.SNS.MOBILE.APNS.PUSH_TYPE&MessageAttributes.entry.2.key=AWS.SNS.MOBILE.APNS.PRIORITY`. `MessageAttributes.entry.N.value` | **string**
Обязательное поле.
Значение атрибута. `N` — числовое значение.
Пример: `MessageAttributes.entry.1.value={"DataType":"String","StringValue":"background"}&MessageAttributes.entry.2.value={"DataType":"String","StringValue":"5"}`. `TargetArn` | **string**
Обязательное поле.
Идентификатор (ARN) мобильного эндпоинта. Обязательно должен быть задан один из параметров: `TargetArn` или `PhoneNumber`. Параметр не может быть задан одновременно с `PhoneNumber`.
Пример: `arn:aws:sns::aoegtvhtp8ob********:endpoint/GCM/test-cns-9990/4cbe148515360244248c993abe0a12884d162bb15e87d6c16bd0c810********`. `PhoneNumber` | **string**
Обязательное поле.
Номер телефона в формате [E.164](https://ru.wikipedia.org/wiki/E.164). Поддерживается отправка SMS на российские номера. Обязательно должен быть задан один из параметров: `TargetArn` или `PhoneNumber`. Параметр не может быть задан одновременно с `TargetArn`. `ResponseFormat` | **string**
Формат ответа.
Возможные значения: ### Атрибуты {#attributes} С помощью атрибутов вы можете передать специфичные для мобильной платформы параметры. В значениях `MessageAttributes` нельзя передать бинарные данные. #### Атрибуты APNS и APNS_SANDBOX {#attributes-apns} Атрибут | Описание --- | --- AWS.SNS.MOBILE.APNS.TTL | Время жизни уведомления в секундах. AWS.SNS.MOBILE.APNS_SANDBOX.TTL | Время жизни уведомления в секундах. Для тестируемых приложений. AWS.SNS.MOBILE.APNS_VOIP.TTL | Время жизни уведомления о входящем VoIP-вызове в секундах. AWS.SNS.MOBILE.APNS_VOIP_SANDBOX.TTL | Время жизни уведомления о входящем VoIP-вызове в секундах. Для тестируемых приложений. AWS.SNS.MOBILE.APNS.COLLAPSE_ID | Идентификатор для нескольких уведомлений, которые сворачиваются в одно. AWS.SNS.MOBILE.APNS.PRIORITY | Приоритет вывода уведомления. Значение от `1` до `10`. AWS.SNS.MOBILE.APNS.PUSH_TYPE | Тип уведомления. Подробнее в [документации Apple](https://developer.apple.com/documentation/usernotifications/sending-notification-requests-to-apns#Know-when-to-use-push-types). AWS.SNS.MOBILE.APNS.TOPIC | Тема уведомления. Подробнее в [документации Apple](https://developer.apple.com/documentation/usernotifications/sending-notification-requests-to-apns#Send-a-POST-request-to-APNs). #### Атрибуты FCM {#attributes-fcm} Атрибут | Описание --- | --- AWS.SNS.MOBILE.FCM.TTL | Время жизни сообщения в секундах. #### Атрибуты SMS {#attributes-sms} Атрибут | Описание --- | --- AWS.SNS.SMS.SenderID | Текстовое имя отправителя. AWS.SNS.SMS.SMSType | Тип SMS.
Возможные значения: #### Атрибуты RUSTORE {#attributes-rustore} Атрибут | Описание --- | --- CNS.MOBILE.RUSTORE.TTL | Время жизни сообщения в секундах. ## Ответ {#response} ### Успешный ответ {#response-200} При отсутствии ошибок Cloud Notification Service отвечает HTTP-кодом `200`. ### Ответ с ошибкой {#response-4xx} При возникновении ошибки Cloud Notification Service отвечает сообщением с соответствующим HTTP-кодом. Перечень общих кодов ошибок для всех действий приведен в разделе [Ошибки](common-errors.md). Ошибки, специфичные для действия `Publish`: HTTP | Код ошибки | Дополнительный код | Описание --- | --- | --- | --- 400 | InvalidParameter | InvalidMessageAttribute | Передан неверный атрибут `MessageAttribute`. Название атрибута содержится в поле `ParamName`. 400 | InvalidParameter | MessageLimitExceeded | Размер сообщения вместе с атрибутами превышает лимит. 400 | InvalidParameter | SMSBodyWithMixedWords | Попытка отправить SMS, в тексте которого есть слова из комбинации латинских и кириллических символов. 400 | UserError | SMSSandboxNumberNotVerified | Попытка отправить SMS на неподтвержденный номер телефона через канал SMS-уведомлений в [песочнице](../concepts/sms.md#sandbox). 400 | UserError | WrongSMSChannelState | Попытка отправить SMS из канала, который находится в состоянии, не позволяющим отправлять сообщения. 400 | UserError | SMSChannelIsBanned | Попытка отправить SMS через заблокированный канал. 400 | UserError | InvalidPhoneNumberRegion | Нельзя использовать телефонные номера не из России. #### Полезные ссылки {#see-also} * [Обзор HTTP API Yandex Cloud Notification Service](index.md) * [Отправить запрос HTTP API к Yandex Cloud Notification Service](send-request.md) * [API action Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) в документации AWS