Help Center> Simple Message Notification> API Reference> APIs> Application Endpoint Operations> Adding an Application Endpoint
View PDF

Adding an Application Endpoint

Function

This API is used to add an endpoint to a platform application.

URI

POST /v2/{project_id}/notifications/applications/{application_urn}/endpoints

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

See Obtaining a Project ID.

application_urn

Yes

String

Specifies the unique resource identifier of the application. You can obtain it based on Querying Platform Applications.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

token

Yes

String

Specifies the mobile device token, which cannot exceed 512 bytes.

user_data

Yes

String

Specifies description or additional information about the endpoint. The value is a UTF-8 encoded string not exceeding 2048 bytes.

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

endpoint_urn

String

Specifies the unique resource identifier of the endpoint.

Status code: 400

Table 5 Response body parameters

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

Table 6 Response body parameters

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

Table 7 Response body parameters

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

Table 8 Response body parameters

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

None

Status Codes

Status Code

Description

201

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.