Adding a Subscription

Function

This API is used to add a subscription to a specified topic. If the status of the subscription is unconfirmed, a confirmation message is sent to the subscriber. After confirming the subscription, the subscriber can receive notification messages published to the topic. By default, 10,000 subscriptions can be added to a topic. However, in rare high-concurrency scenarios, extra subscriptions may be added successfully. The API is idempotent. If the added subscription already exists, a successful result and status code 200 are returned. Otherwise, the status code is 201.

URI

POST /v2/{project_id}/notifications/topics/{topic_urn}/subscriptions

**Table 1** Path Parameters
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.
topic_urn	Yes	String	Specifies the resource identifier of the topic, which is unique. To obtain the resource identifier, see Querying Topics.

Request Parameters

**Table 2** Request header 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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
protocol	Yes	String	Specifies the subscription protocol. (Different protocols indicate different types of endpoints to receive messages.) The following protocols are supported: email: The endpoints are email addresses. sms: The endpoints are phone numbers. functionstage: FunctionGraph (function) transmission protocol. The endpoints are functions. http and https: The endpoints are URLs. callnotify: The endpoints are phone numbers.
endpoint	Yes	String	Note: For an HTTPS subscription, the endpoint starts with https://. For an email subscription, the endpoint must be an email address. For an SMS subscription, the endpoint is a phone number. For a FunctionStage protocol, the endpoint must be a function. For a DMS subscription, the endpoint is a message queue. For an application subscription, the endpoint must be a mobile device added to a platform application. For a voice notification subscription, the endpoint is a phone number.
remark	No	String	Specifies the remarks. The remarks must be UTF-8-coded and can contain up to 128 bytes.

Response Parameters

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
subscription_urn	String	Specifies the resource identifier of a subscription, which is unique.

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 a subscription to a specified topic

POST https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1/subscriptions

{
  "protocol" : "email",
  "endpoint" : "xxx@xxx.com",
  "remark" : "O&M"
}

Example Responses

Status code: 201

[ {
  "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085",
  "subscription_urn" : "urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1:2e778e84408e44058e6cbc6d3c377837"
} ]