Query Events for a Tenant

Retrieve the supported events and their notification settings for a tenant.

Request URL

GET {base_url}/uc-notification/api/v1/event-notification/event-types

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Array<Event_Type> The supported events and their notification settings for the tenant.
Event_Type
Parameter Type Description
category String The category of the events.
  • TELEPHONY
events Array<Event_List> The supported events in the category.
Event_List
Parameter Type Description
eventCode String The event code.
  • EMERGENCY_CALL_DIALED_OUT: A user dialed an emergency number.
  • INBOUND_CALL_REJECTED_STIR_SHAKEN: An inbound call was rejected because the caller's identity failed STIR/SHAKEN verification.
eventName String The name of the event.
level String The alarm level of the event.
  • ALERT
  • WARNING
  • INFORMATION
notificationEnabled Boolean Whether notification for the event is enabled.
  • true: Enabled
  • false: Disabled

Example

Request example

GET /uc-notification/api/v1/event-notification/event-types HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDYwNzMxNywiaWF0IjoxNzkwNTg1NzE3LCJqdGkiOiIxNzZkY2NhMy1hNTYyLTQ2MzctYjU3Ny0yNzRiZTQ2Y2U4NDAiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.KPxN1ik0LSRbC1j4uU2OEYu4itse9qv3DVgCi_uFJvteI2b231kCk2iW-PRAA9rl_WwC7-_1sAjT6XUgwb_szdSbeSAyeerlEnYN0FFZf7AOnKgYj8I480i3lqcEXUOEtxLZJM7vAdPoXvCf_irwSlBOTcYTV1ZxFVpmamI39wUDnaw0J2GQlUo_yNiB1m1sFR6V8QmFz84ohcJGFfud9N6VwIS8NU618BH3dSnfri8HO9Ebv5qZ5WXDqGxto3wa-l5n3uqqUocDRe49-GG79Kv_bb3hoeVNzEe8DUUkEAX23X4vWTYvJwEjCatSvzKsW78qU7F1uib-mq6WEJfmUQ
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "result": [
    {
      "category": "TELEPHONY",
      "events": [
        {
          "eventCode": "EMERGENCY_CALL_DIALED_OUT",
          "eventName": "Emergency Call Dialed out",
          "level": "ALERT",
          "notificationEnabled": true
        },
        {
          "eventCode": "INBOUND_CALL_REJECTED_STIR_SHAKEN",
          "eventName": "Inbound Call Rejected due to STIR/SHAKEN Verification Failure",
          "level": "WARNING",
          "notificationEnabled": true
        }
      ]
    }
  ],
  "requestId": "e99737728ebe113cf3fbf29fd7ad04b3",
  "code": "200",
  "message": "SUCCESS"
}