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.

Calling Method

For details, see Calling APIs.

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: SMS transmission protocol. The endpoints are phone numbers. functionstage: FunctionGraph(function) transmission protocol. The endpoints are functions. functiongraph: FunctionGraph(workflow) transmission protocol. The endpoints are FunctionGraph workflows orchestrated by the FunctionGraph function. http and https: The endpoints are URLs. callnotify: The endpoints are phone numbers. wechat: WeChat group chatbot transmission protocol dingding: DingTalk group chatbot transmission protocol feishu: Lark group chatbot transmission protocol welink: WeLink group chatbot transmission protocol
endpoint	Yes	String	Note: If you use the HTTP protocol, start the endpoint with http://. If you use the HTTPS protocol, start the endpoint with https://. If you use the email protocol, enter an email address. If you use the SMS protocol, enter a phone number. If you use the FunctionGraph (function) protocol, enter a function. If you use the FunctionGraph (workflow) protocol, enter a workflow. If you use the DMS protocol, enter a message queue. If you use the application protocol, enter a mobile device added to a platform application. If you use the voice notification protocol, enter a phone number. If you use the DingTalk chatbot protocol, enter the webhook URL of a custom DingTalk group chatbot or openConversationId of a group to which an enterprise DingTalk chatbot is added. When you add openConversationId, do not start the endpoint with http:// or https://. If you use the WeCom chatbot protocol, enter the webhook URL of a WeCom group chatbot. If you use the Lark chatbot protocol, enter the webhook URL of a Lark group chatbot. If you use the WeLink protocol, enter a WeLink group number.
remark	No	String	Specifies the remarks. The remarks must be UTF-8-coded and can contain up to 128 bytes.
extension	No	SubscriptionExtension object	Specifies the extension information.

**Table 4** SubscriptionExtension
Parameter	Mandatory	Type	Description
client_id	No	String	Specifies the application ID. This field is mandatory when you set protocol to welink. Obtain the value from WeLink. Minimum: 1 Maximum: 64
client_secret	No	String	Specifies the application secret. This field is mandatory when you set protocol to welink. Obtain the value from WeLink. Minimum: 1 Maximum: 64
keyword	No	String	Specifies the keyword. When you set protocol to feishu, you must set either keyword or sign_secret. When you add a keyword for security verification on the Lark chatbot or a custom DingTalk chatbot, keyword must be one of the keywords you entered for the Lark chatbot or the custom DingTalk chatbot. Minimum: 0 Maximum: 20
sign_secret	No	String	Specifies the key. When you set protocol to feishu, you must set either this parameter or keyword. The value of this parameter must be the same as that you customized for the Lark chatbot or the custom DingTalk chatbot. For example, if you set only key for the Lark chatbot, enter the value of key. If you set only keyword for the Lark chatbot, skip this field. Minimum: 0 Maximum: 256

Response Parameters

Status code: 201

**Table 5** 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 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: 403

**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: 404

**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.

Status code: 500

**Table 9** 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 the topic named test_topic_v1

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"
} ]