更新时间:2023-11-30 GMT+08:00
分享

创建Application(废弃)

功能介绍

创建平台应用。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/notifications/applications

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

获取项目ID请参考 获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

应用名。

最大支持64个字符,只能包含英文字母、下划线和数字。

platform

String

应用平台。

目前仅支持HMS、APNS、APNS_SANDBOX。

HMS是为开发者提供的消息推送平台。

APNS和APNS_SANDBOX是用于推送iOS消息的服务平台。

platform_principal

String

对于HMS平台是APP ID,只能包含英文字母和数字,最大20个字符。 对于苹果APNS、APNS_SandBox平台是推送证书,大小不超过8K,且是Base64编码。

platform_credential

String

对于HMS平台是APP SECRET, 只能包含英文字母和数字,32到64个字符。

对于苹果APNS、APNS_SandBox平台是推送证书的私钥(private key), 大小不超过8K,且是Base64编码。

响应参数

状态码: 201

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

application_urn

String

Application的唯一资源标识。

application_id

String

Application资源的ID。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码: 403

表6 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码: 404

表7 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码: 500

表8 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

请求示例

创建Application

POST https://{SMN_Endpoint}/v2/{project_id}/notifications/applications

{
  "name" : "application_name",
  "platform" : "HMS",
  "platform_principal" : "appId",
  "platform_credential" : "appSecret"
}

响应示例

状态码: 201

OK

{
  "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085",
  "application_urn" : "urn:smn:regionId:429ffced18074da0938112f2c362b935:app-APNS-application_name002",
  "application_id" : "a3a4643dc12b4g77ad6e35a16002558c"
}

状态码

状态码

描述

201

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档