推送消息給iOS設備。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
mpush:PushMessageToiOS | none | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppKey | long | 是 | AppKey 信息。 | 24780725 |
Target | string | 是 | 推送目標??扇≈担?/p>
| ALL |
TargetValue | string | 是 | 根據 Target 來設定,多個值使用逗號分隔,超過限制需要分多次推送。
| all |
Title | string | 是 | 發送的消息的標題。 | my title |
Body | string | 是 | 發送的消息內容。 | my body |
StoreOffline | boolean | 否 | 消息是否離線保存。StoreOffline 默認設置為 false。 若保存,在推送時候用戶不在線,在過期時間(ExpireTime)內用戶上線時會被再次發送。ExpireTime 默認為 72 小時。 | true |
JobKey | string | 否 | 推送任務自定義標識,當 JobKey 不為空時,回執日志中會附帶該字段。查看回執日志參見回執日志。 | 123 |
返回參數
示例
正常返回示例
JSON
格式
{
"MessageId": "501029",
"RequestId": "9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-10-12 | OpenAPI 去除了 deprecated 標記、OpenAPI 入參發生變更 | 查看變更詳情 |