Download OpenAPI specification:Download
address_id | Array of strings address id. |
address_list_id | Array of strings address list id. |
address | Array of strings address details, could be email address for email, user id for websocket, mobile number for sms. |
notify_type | Array of strings the notification type , eg:[email|websocket|sms|wechat]. |
status | Array of strings address status, eg:[active|disabled|deleted]. |
limit | integer <int64> data limit per page, default value 20, max value 200. |
offset | integer <int64> beginning data offset of this page, default 0. |
search_word | string query key, support these fields(address_id,address,notify_type,remarks). |
sort_key | string sort key, order by sort_key, default create_time. |
reverse | boolean <boolean> value = 0 sort ASC, value = 1 sort DESC. |
display_columns | Array of strings select columns to display, currently not support. |
A successful response.
address_id | Array of strings (required, address id) |
A successful response.
address | string required, address details, could be email address for email, user id for websocket, mobile number for sms. |
remarks | string (remarks for address) |
verification_code | string (verification code for register address at the first time) |
notify_type | string (required, the notification type , eg:[email|websocket|sms|wechat]) |
A successful response.
address required | string required, address id |
address | string (required, address id) |
address_detail | string address details, could be email address for email, user id for websocket, mobile number for sms. |
remarks | string (remarks for address) |
verification_code | string (verification code for register address at the first time) |
notify_type | string (the notification type, eg:[email|websocket|sms|wechat]) |
A successful response.
address_list_id | Array of strings address list id. |
address_list_name | Array of strings the name of the address list. |
extra | Array of strings the extra info of the address. |
status | Array of strings address list status, eg:[active|disabled|deleted]. |
limit | integer <int64> data limit per page, default value 20, max value 200. |
offset | integer <int64> beginning data offset of this page, default 0. |
search_word | string query key, support these fields(address_list_id,address_list_name,address_list_name,extra). |
sort_key | string sort key, order by sort_key, default create_time. |
reverse | boolean <boolean> value = 0 sort ASC, value = 1 sort DESC. |
display_columns | Array of strings select columns to display, currently not support. |
A successful response.
address_list_id | Array of strings (required, address list id) |
A successful response.
address_list_name | string (the name of the address list) |
extra | string (the extra info of the address) |
address_id | Array of strings (required, the address ids for the address list to create) |
A successful response.
addresslist required | string required, address list id |
addresslist | string (required, address list id) |
address_list_name | string (address list name) |
extra | string (the extra info of the address list) |
status | string (address list status, eg:[active|disabled|deleted]) |
address_id | Array of strings (address ids of the address list) |
A successful response.
notification_id | Array of strings notification id. |
content_type | Array of strings notification content type, eg:[invite|verify|fee|business|alert|other|event]. |
owner | Array of strings notification owner. |
status | Array of strings notification status, eg:[pending|sending|successful|failed]. |
limit | integer <int64> data limit per page, default value 20, max value 200. |
offset | integer <int64> beginning data offset of this page, default 0. |
search_word | string query key, support these fields(notification_id,content_type,title,short_content,address_info,status,owner). |
sort_key | string sort key, order by sort_key, default create_time. |
reverse | boolean <boolean> value = 0 sort ASC, value = 1 sort DESC. |
display_columns | Array of strings select columns to display, currently not support. |
A successful response.
content_type | string (required, notification content type, eg:[invite|verify|fee|business|alert|other|event]) |
title | string (required, notification title) |
content | string (notification content, json fmt, eg:{"html":"test_content_html", "normal":"test_content_normal"}) |
short_content | string (notification short content) |
expired_days | integer <int64> notification expired days, 0 is for never expired. |
owner | string (notification owner) |
address_info | string the address to send the notification, json fmt, currently support 2 kinds types. 1.key/value Type, key is the notification send Type,the value is the list of address, eg:{"email": ["xxx1@163.com", "xxx2@163.com"],"websocket": ["system", "user1"]} 2.Array Type, eg:["adl-xxxx1", "adl-xxxx2"], the item is the address list id which is already created in advance. |
available_start_time | string (the available start time to receive notification) |
available_end_time | string (the available end time to receive notification) |
extra | string (extra info is only used for websocket notification,to show which websocket client could accept it.
eg:"{"ws_service": "ks","ws_message_type": "event"}") |
A successful response.
notification_id | Array of strings (required, notification ids to retry) |
A successful response.
service_type | Array of strings required, service type. |
A successful response.
email_service_config | object (pbEmailServiceConfig) |
A successful response.
email_service_config | object (pbEmailServiceConfig) |
A successful response.
task_id | Array of strings task id. |
notification_id | Array of strings the notification id of the task, one notification may send out by serval tasks. |
error_code | Array of strings error code, if task run failed will return a error code. |
status | Array of strings the task execution status, eg:[pending|sending|successful|failed]. |
limit | integer <int64> data limit per page, default value 20, max value 200. |
offset | integer <int64> beginning data offset of this page, default 0. |
search_word | string query key, support these fields(task_id,notification_id,status,error_code). |
sort_key | string sort key, order by sort_key, default create_time. |
reverse | boolean <boolean> value = 0 sort ASC, value = 1 sort DESC. |
display_columns | Array of strings select columns to display, currently not support. |
A successful response.
task_id | Array of strings (required, task ids to retry) |
A successful response.