Creating a Platform Application (Deprecated)
Function
This API is used to create a platform application.
URI
POST /v2/{project_id}/notifications/applications
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID.For details about how to obtain the project ID, see Obtaining the Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies a user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Specifies the application name. The name can contain a maximum of 64 characters, including only letters, underscores (_), and digits. |
platform |
Yes |
String |
Specifies the application platform. Only HMS, APNS, and APNS_SANDBOX are supported. HMS is a platform for developers to push Android messages. APNS and APNS_SANDBOX are platforms for pushing iOS messages. |
platform_principal |
Yes |
String |
For HMS, set it to the app ID, which contains a maximum of 20 characters, including only letters and digits. For APNS and APNS_SANDBOX, set it to the platform certificate, which is encoded using Base64 and cannot exceed 8 KB. |
platform_credential |
Yes |
String |
For HMS, set it to the app secret, which contains 32 to 64 characters and includes letters and digits only. For APNS and APNS_SANDBOX, set it to the certificate private key, which is encoded using Base64 and cannot exceed 8 KB. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID, which is unique. |
application_urn |
String |
Specifies the unique resource ID of an application. |
application_id |
String |
Specifies the application resource ID. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID, which is unique. |
code |
String |
Specifies the error code. |
message |
String |
Describes the error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID, which is unique. |
code |
String |
Specifies the error code. |
message |
String |
Describes the error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID, which is unique. |
code |
String |
Specifies the error code. |
message |
String |
Describes the error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID, which is unique. |
code |
String |
Specifies the error code. |
message |
String |
Describes the error message. |
Example Requests
Creating a platform application
POST https://{SMN_Endpoint}/v2/{project_id}/notifications/applications { "name" : "application_name", "platform" : "HMS", "platform_principal" : "appId", "platform_credential" : "appSecret" }
Example Responses
Status code: 201
OK
{ "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085", "application_urn" : "urn:smn:regionId:429ffced18074da0938112f2c362b935:app-APNS-application_name002", "application_id" : "a3a4643dc12b4g77ad6e35a16002558c" }
Status Codes
Status Code |
Description |
---|---|
201 |
OK |
400 |
Bad Request |
403 |
Unauthorized |
404 |
Not Found |
500 |
Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot