Adding an Application Endpoint (Deprecated)
Function
This API is used to add an endpoint to a platform application.
URI
POST /v2/{project_id}/notifications/applications/{application_urn}/endpoints
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. |
application_urn |
Yes |
String |
Specifies the unique resource identifier of the application. To obtain it, see Querying an Application. |
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 |
---|---|---|---|
token |
Yes |
String |
Specifies the mobile device token, which cannot exceed 512 bytes. |
user_data |
Yes |
String |
Specifies the description or additional information about the endpoint. The value is a UTF-8 encoded string not exceeding 2,048 bytes. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID, which is unique. |
endpoint_urn |
String |
Specifies the unique resource ID of an endpoint. |
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
Adding an application endpoint
POST https://{SMN_Endpoint}/v2/{project_id}/notifications/applications/{application_urn}/endpoints { "token" : "3708232124742383445", "user_data" : "This is token for user001" }
Example Responses
Status code: 201
OK
{ "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085", "endpoint_urn" : "urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:endpoint-APNS-example_application_name-37a2cb947fa43a20bc66e91281194e7a" }
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