PushMessageToiOS - 推送消息给iOS设备

更新时间:
复制为 MD 格式

推送消息到iOS设备端,消息通过阿里云推送自有通道下发。设备上App接收到消息后,需要自行处理后续动作,比如实现业务行为,或者构造本地通知弹出等。

接口说明

这个接口即将废弃,请使用具备更多推送能力的高级推送接口,在该接口中指定推送平台DeviceTypeiOS,推送类型PushTypeMESSAGE,即可达到同样效果。

请确保在使用该接口前,以充分了解 EMAS 移动推送产品的收费方式和价格

该接口默认只把消息发送给在线设备,若设备离线,则需要设置StoreOffline参数,推送系统会保存该消息,等到设备上线后再自动下发信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mpush:PushMessageToiOS

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

AppKey

integer

AppKey 信息。

24780725

Target

string

推送目标。可取值:

  • DEVICE:根据设备推送

  • ACCOUNT:根据账号推送

  • ALIAS:根据别名推送

  • TAG:根据标签推送

  • ALL:推送给全部设备

ALL

TargetValue

string

根据 Target 来设定,多个值使用逗号分隔,超过限制需要分多次推送。

  • Target=DEVICE,值如deviceid111,deviceid1111(最多支持 1000 个)。

  • Target=ACCOUNT,值如account111,account222(最多支持 1000 个)。

  • Target=ALIAS,值如alias111,alias222(最多支持 1000 个)。

  • Target=TAG,支持单 Tag 和多 Tag,格式请参见标签格式

  • Target=ALL,值为 all

all

Title

string

发送的消息的标题。

my title

Body

string

发送的消息内容。

my body

StoreOffline

boolean

消息是否离线保存。StoreOffline 默认设置为 false。

若保存,在推送时候用户不在线,在过期时间(ExpireTime)内用户上线时会被再次发送。ExpireTime 默认为 72 小时。

true

JobKey

string

推送任务自定义标识,当 JobKey 不为空时,回执日志中会附带该字段。查看回执日志参见回执日志

123

返回参数

名称

类型

描述

示例值

object

MessageId

string

标志一次推送的消息 ID。

501029

RequestId

string

请求 ID。

9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC

示例

正常返回示例

JSON格式

{
  "MessageId": "501029",
  "RequestId": "9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情