推送通知給iOS設(shè)備,iOS設(shè)備需要處于在線狀態(tài)。
接口說明
請確保在使用該接口前,以充分了解 EMAS 移動推送產(chǎn)品的收費(fèi)方式和價格。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
mpush:PushNoticeToiOS | none | *全部資源 * |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppKey | long | 是 | AppKey 信息。 | 24780725 |
Target | string | 是 | 推送目標(biāo)。可取值:
| ALL |
TargetValue | string | 是 | 根據(jù) Target 來設(shè)定,多個值使用逗號分隔,超過限制需要分多次推送。
| ALL |
ApnsEnv | string | 是 | iOS 的通知是通過 APNS 中心來發(fā)送的,需要填寫對應(yīng)的環(huán)境信息。
| DEV |
Title | string | 否 | 推送的通知的標(biāo)題。
| title |
Body | string | 是 | 推送的通知內(nèi)容。 | Hello World |
JobKey | string | 否 | 推送任務(wù)自定義標(biāo)識,當(dāng) JobKey 不為空時,回執(zhí)日志中會附帶該字段。查看回執(zhí)日志參見回執(zhí)日志。 | 123 |
ExtParameters | string | 否 | 自定義的 KV 結(jié)構(gòu),開發(fā)者擴(kuò)展用。 說明
針對 iOS 設(shè)備,該參數(shù)要以 JSON map 的格式傳入,否則會解析出錯。
| {"k1":"ios","k2":"v2"} |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"MessageId": "9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC",
"RequestId": "501029"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-01-22 | API 內(nèi)部配置變更,不影響調(diào)用 | 查看變更詳情 |