Congestion notification details

On this page, you will find the JSON schema for Congestion notifications. Its purpose is to monitor changes made to congestion level subscriptions, such as creation, modification, the several outcomes for these changes and the current congestion state, e.g.: high, low, etc. Underneath the JSON schema, there is a table with further information on the specific keyword values.

Remember that the string values represented below are just examples that can be used. So, they should contain your real congestion values.

JSON schema for Congestion

{
    "id": "2628b42e-8789-4fcd-942a-841f16f52897",
    "source": "org.camaraproject.congestioninsights.v0.event",
    "type": "event",
    "specversion": "1.0",
    "datacontenttype": "application/json",
    "time": "2025-04-18T12:54:21.495311",
    "data": {
        "level": "medium"
    }
}
Keyword valuesDescription
idA string value with the event subscription identifier.
sourceA string value that identifies the source where the event happened. It contains the Network as Code API implementation and subscription ID.
typeA string value returned by the API with different statuses.
specversionA string representing the specification version.
datacontenttypeIt indicates the media type for the event payload encoding. It must be "application/json" in the context of CAMARA APIs
timeA string value with the time the event occurred. Date and time are specified in ISO 8601 format, e.g.: 2023-08-20T21:01:02.345Z.
dataAn object that will contain other objects or strings, such as congestion level data.
levelA string specifying the congestion levels, which can be: "none", "low", "medium", "high".

Last updated on May 23, 2024