onesignal https://onesignal.com/api/v1/notifications参数与返回值
时间: 2023-07-14 18:58:19 浏览: 56
Onesignal API的参数和返回值如下:
**参数:**
- app_id (string, required):OneSignal应用程序的ID。
- contents (object, optional):通知的消息内容,可以是纯文本字符串或包含多个文本字段的对象。例如:`{"en": "English Message", "es": "Mensaje en español"}`。
- headings (object, optional):通知的消息标题,可以是纯文本字符串或包含多个文本字段的对象。例如:`{"en": "English Title", "es": "Título en español"}`。
- subtitle (object, optional):通知的消息副标题,可以是纯文本字符串或包含多个文本字段的对象。例如:`{"en": "English Subtitle", "es": "Subtítulo en español"}`。
- template_id (string, optional):使用OneSignal模板的ID,以自定义通知的外观和功能。
- included_segments (array, optional):要发送通知的用户的段列表。
- excluded_segments (array, optional):不要发送通知的用户的段列表。
- include_player_ids (array, optional):要发送通知的单个用户的ID列表。
- included_ios_badge_count (number, optional):在iOS上显示的徽章计数。
- android_channel_id (string, optional):在Android上使用的通知渠道的ID。
- small_icon (string, optional):在通知中使用的小图标的名称或资源ID。
- large_icon (string, optional):在通知中使用的大图标的名称或资源ID。
- big_picture (string, optional):在通知中使用的大图片的URL地址。
- buttons (array, optional):在通知中显示的按钮列表。每个按钮都包含文本和一个打开URL或执行操作的URL。
- web_buttons (array, optional):在浏览器中打开的按钮列表。每个按钮都包含文本和一个打开URL的URL。
- ios_attachments (object, optional):在iOS上使用的附件。可以是单个文件或多个文件的对象。例如:`{"id1": "https://example.com/image.png", "id2": "https://example.com/audio.mp3"}`。
- android_background_layout (object, optional):在Android上使用的后台布局。可以是纯文本字符串或包含多个文本字段的对象。例如:`{"headings_color": "FFFF0000", "contents_color": "FF00FF00"}`。
- ttl (number, optional):通知的生存时间(以秒为单位)。
- priority (number, optional):通知的优先级。值为-2、-1、0、1或2。
- sound (string, optional):要在通知中播放的声音的名称或资源ID。
- android_led_color (string, optional):在Android上使用的LED颜色。
- android_accent_color (string, optional):在Android上使用的强调颜色。
- android_visibility (number, optional):在Android上通知的可见性。值为0、1或-1。
- ios_sound (string, optional):要在iOS上播放的声音的名称或资源ID。
- ios_badgeType (string, optional):在iOS上使用的徽章类型。值为none、setTo、increment或decrement。
- ios_badgeCount (number, optional):在iOS上显示的徽章计数。
- ios_category (string, optional):在iOS上使用的通知类别。
- content_available (boolean, optional):指示是否应在iOS上启用静默通知。
- mutable_content (boolean, optional):指示是否应在iOS上启用可变通知。
- url (string, optional):在通知中包含的URL地址。
**返回值:**
- id (string):通知的唯一ID。
- recipients (number):接收通知的用户数。
- errors (array):发送通知时出现的任何错误。每个错误都是一个字符串,包含出错的用户ID和错误描述。