User Channel

Package : spaceone.api.notification.v1

UserChannel

UserChannel Methods:

NO	Method	Request Type	Response Type	Description
1	create	CreateUserChannelRequest	UserChannelInfo
2	update	UpdateUserChannelRequest	UserChannelInfo
3	set_subscription	UpdateSubscriptionRequest	UserChannelInfo
4	enable	UserChannelRequest	UserChannelInfo
5	disable	UserChannelRequest	UserChannelInfo
6	delete	UserChannelRequest	google.protobuf.Empty
7	get	GetUserChannelRequest	UserChannelInfo
8	list	UserChannelQuery	UserChannelsInfo
9	stat	UserChannelStatQuery	google.protobuf.Struct

create

POST /notification/v1/user-channels

Type	Message
Request	CreateUserChannelRequest
Response	UserChannelInfo

update

PUT /notification/v1/user-channel/{user_channel_id}

Type	Message
Request	UpdateUserChannelRequest
Response	UserChannelInfo

set_subscription

PUT /notification/v1/user-channel/{user_channel_id}/subscription

Type	Message
Request	UpdateSubscriptionRequest
Response	UserChannelInfo

enable

PUT /notification/v1/user-channel/{user_channel_id}/enable

Type	Message
Request	UserChannelRequest
Response	UserChannelInfo

disable

PUT /notification/v1/user-channel/{user_channel_id}/disable

Type	Message
Request	UserChannelRequest
Response	UserChannelInfo

delete

DELETE /notification/v1/user-channel/{user_channel_id}

Type	Message
Request	UserChannelRequest
Response	google.protobuf.Empty

get

GET /notification/v1/user-channel/{user_channel_id}

Type	Message
Request	GetUserChannelRequest
Response	UserChannelInfo

list

GET /notification/v1/user-channels

POST /notification/v1/user-channels/search

Type	Message
Request	UserChannelQuery
Response	UserChannelsInfo

stat

POST /notification/v1/user-channels/stat

Type	Message
Request	UserChannelStatQuery
Response	google.protobuf.Struct

Message

CreateUserChannelRequest

No	Field	Type	Required	Description
1	protocol_id	string	✅
2	name	string	✅
3	schema	string	✅
4	data	google.protobuf.Struct	✅
5	is_subscribe	bool	❌
6	subscriptions	list of string	❌
7	schedule	UserChannelSchedule	❌
8	tags	google.protobuf.Struct	❌
9	user_id	string	✅
10	domain_id	string	✅

GetUserChannelRequest

No	Field	Type	Required	Description
1	user_channel_id	string	✅
2	domain_id	string	✅
3	only	list of string	❌

UpdateSubscriptionRequest

No	Field	Type	Required	Description
1	user_channel_id	string	✅
2	is_subscribe	bool	✅
3	subscriptions	list of string	❌
4	domain_id	string	✅

UpdateUserChannelRequest

No	Field	Type	Required	Description
1	user_channel_id	string	✅
2	name	string	❌
3	data	google.protobuf.Struct	❌
4	schedule	UserChannelSchedule	❌
5	tags	google.protobuf.Struct	❌
6	domain_id	string	✅

UserChannelInfo

No	Field	Type	Description
1	user_channel_id	string
2	name	string
3	state	NONE ENABLED DISABLED
4	schema	string
5	data	google.protobuf.Struct
6	secret_id	string
7	is_subscribe	bool
8	subscriptions	list of string
9	schedule	UserChannelSchedule
10	tags	google.protobuf.Struct
11	protocol_id	string
12	user_id	string
13	domain_id	string
14	created_at	string

UserChannelQuery

No	Field	Type	Required	Description
1	query	spaceone.api.core.v1.Query	❌
2	user_channel_id	string	❌
3	name	string	❌
4	state	NONE ENABLED DISABLED	❌
5	schema	string	❌
6	secret_id	string	❌
7	protocol_id	string	❌
8	user_id	string	❌
9	domain_id	string	✅

UserChannelRequest

No	Field	Type	Required	Description
1	user_channel_id	string	✅
2	domain_id	string	✅

UserChannelSchedule

No	Field	Type	Description
1	day_of_week	NONE MON TUE WED THU FRI SAT SUN
2	start_hour	int32
3	end_hour	int32

UserChannelStatQuery

No	Field	Type	Required	Description
1	query	spaceone.api.core.v1.StatisticsQuery	✅
2	domain_id	string	✅

UserChannelsInfo

No	Field	Type	Description
1	results	list of UserChannelInfo
2	total_count	int32