Jump to

• Request
• Response

Add a new config element: SD.account-config

post

https://cloud-native-SBC-IP/config/v1/sd/account-config

Add a new config element: SD.account-config

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

configure Quality of Service accounting

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• cdr-attribute-include-list: array cdr-attribute-include-list
  list of cdr attributes to be included in accounting file
• file-output: boolean
  activate writing of comma delimited records
• file-rotate-time: integer (int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  file rotation/push interval (minutes) (0 disables)
• file-sequence-number: boolean
  append 9-digit sequence number to CDR file names
• generate-event: array generate-event
  list of events like REGISTER, MESSAGE to collect. To disable leave blank (default)
• generate-interim: array generate-interim
  list of events to collect during a session
• generate-start: string
  Allowed Values: [ "None", "Invite", "OK" ]
• hostname: string
  Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$

  hostname of this system
• intermediate-period: integer (int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  periodic interim record interval (seconds)
• max-file-size: integer (int64)
  Minimum Value: 1048576

  Maximum Value: 1073741824

  maximum file size (bytes), should be >= 1048576 bytes and <= 1073741824 bytes
• state: boolean
  administrative state
• trans-at-close: boolean
  transmit data at session close

{
    "properties":{
        "hostname":{
            "description":"hostname of this system",
            "pattern":"^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$",
            "type":"string"
        },
        "state":{
            "description":"administrative state",
            "type":"boolean"
        },
        "trans-at-close":{
            "description":"transmit data at session close",
            "type":"boolean"
        },
        "generate-start":{
            "$ref":"#/components/schemas/AcctStartEventEnum"
        },
        "generate-interim":{
            "description":"list of events to collect during a session",
            "items":{
                "$ref":"#/components/schemas/AcctInterimEventConstraintEnum"
            },
            "type":"array"
        },
        "cdr-attribute-include-list":{
            "description":"list of cdr attributes to be included in accounting file",
            "items":{
                "$ref":"#/components/schemas/CdrAttrEnum"
            },
            "type":"array"
        },
        "generate-event":{
            "description":"list of events like REGISTER, MESSAGE to collect. To disable leave blank (default)",
            "items":{
                "$ref":"#/components/schemas/AcctEventEventEnum"
            },
            "type":"array"
        },
        "intermediate-period":{
            "description":"periodic interim record interval (seconds)",
            "format":"int32",
            "maximum":2147483647,
            "minimum":0,
            "type":"integer"
        },
        "file-output":{
            "description":"activate writing of comma delimited records",
            "type":"boolean"
        },
        "max-file-size":{
            "description":"maximum file size (bytes), should be >= 1048576 bytes and <= 1073741824 bytes",
            "format":"int64",
            "maximum":1073741824,
            "minimum":1048576,
            "type":"integer"
        },
        "file-sequence-number":{
            "description":"append 9-digit sequence number to CDR file names",
            "type":"boolean"
        },
        "file-rotate-time":{
            "description":"file rotation/push interval (minutes) (0 disables)",
            "format":"int32",
            "maximum":2147483647,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure Quality of Service accounting",
    "type":"object"
}

Nested Schema : cdr-attribute-include-list

Type: array

list of cdr attributes to be included in accounting file

Show Source

• Array of: string
  Allowed Values: [ "Access_Network_Information", "Accounting_Session_ID", "Accounting_Session_Time", "Accounting_Status", "Accounting_Termination_Cause", "ApplicationId", "Associated_URI", "Called_Asserted_Identity", "Called_MOS", "Called_R_Factor", "Called_Station_ID", "Calling_MOS", "Calling_R_Factor", "Calling_Station_ID", "Cause_Code", "CDR_Sequence_Number", "Charging_Function_Address", "Charging_Vector_ICID", "Cisco_Connect_Time", "Cisco_Disconnect_Cause", "Cisco_Disconnect_Time", "Cisco_Setup_Time", "Content_Disposition", "Custom_VSA_200", "Custom_VSA_201", "Custom_VSA_202", "Custom_VSA_203", "Custom_VSA_204", "Custom_VSA_205", "Custom_VSA_206", "Custom_VSA_207", "Custom_VSA_208", "Custom_VSA_209", "Custom_VSA_210", "Custom_VSA_211", "Custom_VSA_212", "Custom_VSA_213", "Custom_VSA_214", "Custom_VSA_215", "Custom_VSA_216", "Custom_VSA_217", "Custom_VSA_218", "Custom_VSA_219", "Custom_VSA_220", "Custom_VSA_221", "Custom_VSA_222", "Custom_VSA_223", "Custom_VSA_224", "Custom_VSA_225", "Custom_VSA_226", "Custom_VSA_227", "Custom_VSA_228", "Custom_VSA_229", "Custom_VSA_230", "Destination_Host", "Destination_Realm", "Diam_Session_Id", "Disconnect_Cause", "Disconnect_Initiator", "Early_SDP_Media", "Early_SDP_Type", "Egress_Local_Address", "Egress_Network_Interface_ID", "Egress_Realm", "Egress_Remote_Address", "Egress_Routing_Number", "Egress_RPH", "Egress_Session_ID", "Egress_Vlan_Tag_Value", "Event", "Event_Time", "Expires", "Firmware_Version", "FS1_Called_Media_Stop_Time", "FS1_Calling_Media_Stop_Time", "FS1_F_Flow_Identifier", "FS1_F_Flow_Input_Dest_Address", "FS1_F_Flow_Input_Dest_Port", "FS1_F_Flow_Input_Realm", "FS1_F_Flow_Input_Src_Addr", "FS1_F_Flow_Input_Src_Port", "FS1_F_Flow_Media_Type", "FS1_F_Flow_Output_Dest_Addr", "FS1_F_Flow_Output_Dest_Port", "FS1_F_Flow_Output_Realm", "FS1_F_Flow_Output_Src_Address", "FS1_F_Flow_Output_Src_Port", "FS1_F_Flow_Type", "FS1_R_Flow_Identifier", "FS1_R_Flow_Input_Dest_Address", "FS1_R_Flow_Input_Dest_Port", "FS1_R_Flow_Input_Realm", "FS1_R_Flow_Input_Src_Addr", "FS1_R_Flow_Input_Src_Port", "FS1_R_Flow_Media_Type", "FS1_R_Flow_Output_Dest_Addr", "FS1_R_Flow_Output_Dest_Port", "FS1_R_Flow_Output_Realm", "FS1_R_Flow_Output_Src_Address", "FS1_R_Flow_Output_Src_Port", "FS1_R_Flow_Type", "FS1_RTCP_Called_Avg_Jitter", "FS1_RTCP_Called_Avg_Latency", "FS1_RTCP_Called_Max_Jitter", "FS1_RTCP_Called_Max_Latency", "FS1_RTCP_Called_Packets_Lost", "FS1_RTCP_Calling_Avg_Jitter", "FS1_RTCP_Calling_Avg_Latency", "FS1_RTCP_Calling_Max_Jitter", "FS1_RTCP_Calling_Max_Latency", "FS1_RTCP_Calling_Packets_Lost", "FS1_RTP_Called_Avg_Jitter", "FS1_RTP_Called_Max_Jitter", "FS1_RTP_Called_Octets", "FS1_RTP_Called_Octets_Transmitted", "FS1_RTP_Called_Packets", "FS1_RTP_Called_Packets_Lost", "FS1_RTP_Called_Packets_Transmitted", "FS1_RTP_Calling_Avg_Jitter", "FS1_RTP_Calling_Max_Jitter", "FS1_RTP_Calling_Octets", "FS1_RTP_Calling_Octets_Transmitted", "FS1_RTP_Calling_Packets", "FS1_RTP_Calling_Packets_Lost", "FS1_RTP_Calling_Packets_Transmitted", "FS2_Called_Media_Stop_Time", "FS2_Calling_Media_Stop_Time", "FS2_F_Flow_Identifier", "FS2_F_Flow_Input_Dest_Address", "FS2_F_Flow_Input_Dest_Port", "FS2_F_Flow_Input_Realm", "FS2_F_Flow_Input_Src_Addr", "FS2_F_Flow_Input_Src_Port", "FS2_F_Flow_Media_Type", "FS2_F_Flow_Output_Dest_Addr", "FS2_F_Flow_Output_Dest_Port", "FS2_F_Flow_Output_Realm", "FS2_F_Flow_Output_Src_Address", "FS2_F_Flow_Output_Src_Port", "FS2_F_Flow_Type", "FS2_R_Flow_Identifier", "FS2_R_Flow_Input_Dest_Address", "FS2_R_Flow_Input_Dest_Port", "FS2_R_Flow_Input_Realm", "FS2_R_Flow_Input_Src_Addr", "FS2_R_Flow_Input_Src_Port", "FS2_R_Flow_Media_Type", "FS2_R_Flow_Output_Dest_Addr", "FS2_R_Flow_Output_Dest_Port", "FS2_R_Flow_Output_Realm", "FS2_R_Flow_Output_Src_Address", "FS2_R_Flow_Output_Src_Port", "FS2_R_Flow_Type", "FS2_RTCP_Called_Avg_Jitter", "FS2_RTCP_Called_Avg_Latency", "FS2_RTCP_Called_Max_Jitter", "FS2_RTCP_Called_Max_Latency", "FS2_RTCP_Called_Packets_Lost", "FS2_RTCP_Calling_Avg_Jitter", "FS2_RTCP_Calling_Avg_Latency", "FS2_RTCP_Calling_Max_Jitter", "FS2_RTCP_Calling_Max_Latency", "FS2_RTCP_Calling_Packets_Lost", "FS2_RTP_Called_Avg_Jitter", "FS2_RTP_Called_Max_Jitter", "FS2_RTP_Called_Octets", "FS2_RTP_Called_Octets_Transmitted", "FS2_RTP_Called_Packets", "FS2_RTP_Called_Packets_Lost", "FS2_RTP_Called_Packets_Transmitted", "FS2_RTP_Calling_Avg_Jitter", "FS2_RTP_Calling_Max_Jitter", "FS2_RTP_Calling_Octets", "FS2_RTP_Calling_Octets_Transmitted", "FS2_RTP_Calling_Packets", "FS2_RTP_Calling_Packets_Lost", "FS2_RTP_Calling_Packets_Transmitted", "Generic_ID", "History_Info", "IMEI", "IMSI", "Ingress_Local_Address", "Ingress_Network_Interface_ID", "Ingress_Realm", "Ingress_Remote_Address", "Ingress_RPH", "Ingress_Session_ID", "Ingress_Vlan_Tag_Value", "Intermediate_Time", "Local_timezone", "MSRP_Called_Octets", "MSRP_Called_Octets_Transmitted", "MSRP_Called_Packets", "MSRP_Called_Packets_Transmitted", "MSRP_Calling_Octets", "MSRP_Calling_Octets_Transmitted", "MSRP_Calling_Packets", "MSRP_Calling_Packets_Transmitted", "NAS_IP_Address", "NAS_Port", "Node_Func", "Node_Functionality", "ORIG_IOI", "Origin_Host", "Origin_Realm", "Originating_Trunk_Context", "Originating_Trunk_Group", "Originator", "P_Asserted_ID", "P_Visited_Network_ID", "PGW_IP_Address", "Post_Dial_Delay", "Primary_routing_Number", "refer_call_transfer_ID", "Role_Of_Node", "SDP_Answer_Timestamp", "SDP_Media", "SDP_Offer_Timestamp", "SDP_Type", "Served_Party_IP", "Service_Context_ID", "Session_Disposition", "Session_Forked_Call_Id", "Session_Protocol_Type", "SGW_IP_Address", "SIP_DIVERSION", "Sip_Method", "Sip_Status_Code", "Sms_Called_Party_Number", "Sms_Calling_Party_Number", "Sms_Msg_length", "Sms_Msg_Type", "Stir_Div_Signed_Request", "Stir_Div_Verified_Request", "Stir_Signed_Request", "Stir_Signed_Request_Exception_Id", "Stir_TN_Used_For_AS_VS_Request", "Stir_Verified_Request", "Stir_Verified_Request_Exception_Id", "Stir_VS_Invite_State", "Stir_VS_Reason", "Stir_VS_Verstat", "Subscription_ID_Data", "Subscription_ID_Type", "TERM_IOI", "Terminating_Trunk_Context", "Terminating_Trunk_Group", "User_Name" ]

{
    "description":"list of cdr attributes to be included in accounting file",
    "items":{
        "$ref":"#/components/schemas/CdrAttrEnum"
    },
    "type":"array"
}

Nested Schema : generate-event

Type: array

list of events like REGISTER, MESSAGE to collect. To disable leave blank (default)

Show Source

• Array of: string
  Allowed Values: [ "Register", "Local-Register", "message" ]

{
    "description":"list of events like REGISTER, MESSAGE to collect. To disable leave blank (default)",
    "items":{
        "$ref":"#/components/schemas/AcctEventEventEnum"
    },
    "type":"array"
}

Nested Schema : generate-interim

Type: array

list of events to collect during a session

Show Source

• Array of: string
  Allowed Values: [ "OK", "Reinvite", "Reinvite-Response", "Reinvite-Cancel", "Unsuccessful-Attempt", "Redirect", "Egress-Invite" ]

{
    "description":"list of events to collect during a session",
    "items":{
        "$ref":"#/components/schemas/AcctInterimEventConstraintEnum"
    },
    "type":"array"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return config element: AccountingConfig

Body ()

Root Schema : schema

Type: object

configure Quality of Service accounting

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• cdr-attribute-include-list: array cdr-attribute-include-list
  list of cdr attributes to be included in accounting file
• file-output: boolean
  activate writing of comma delimited records
• file-rotate-time: integer (int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  file rotation/push interval (minutes) (0 disables)
• file-sequence-number: boolean
  append 9-digit sequence number to CDR file names
• generate-event: array generate-event
  list of events like REGISTER, MESSAGE to collect. To disable leave blank (default)
• generate-interim: array generate-interim
  list of events to collect during a session
• generate-start: string
  Allowed Values: [ "None", "Invite", "OK" ]
• hostname: string
  Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$

  hostname of this system
• intermediate-period: integer (int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  periodic interim record interval (seconds)
• max-file-size: integer (int64)
  Minimum Value: 1048576

  Maximum Value: 1073741824

  maximum file size (bytes), should be >= 1048576 bytes and <= 1073741824 bytes
• state: boolean
  administrative state
• trans-at-close: boolean
  transmit data at session close

{
    "properties":{
        "hostname":{
            "description":"hostname of this system",
            "pattern":"^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$",
            "type":"string"
        },
        "state":{
            "description":"administrative state",
            "type":"boolean"
        },
        "trans-at-close":{
            "description":"transmit data at session close",
            "type":"boolean"
        },
        "generate-start":{
            "$ref":"#/components/schemas/AcctStartEventEnum"
        },
        "generate-interim":{
            "description":"list of events to collect during a session",
            "items":{
                "$ref":"#/components/schemas/AcctInterimEventConstraintEnum"
            },
            "type":"array"
        },
        "cdr-attribute-include-list":{
            "description":"list of cdr attributes to be included in accounting file",
            "items":{
                "$ref":"#/components/schemas/CdrAttrEnum"
            },
            "type":"array"
        },
        "generate-event":{
            "description":"list of events like REGISTER, MESSAGE to collect. To disable leave blank (default)",
            "items":{
                "$ref":"#/components/schemas/AcctEventEventEnum"
            },
            "type":"array"
        },
        "intermediate-period":{
            "description":"periodic interim record interval (seconds)",
            "format":"int32",
            "maximum":2147483647,
            "minimum":0,
            "type":"integer"
        },
        "file-output":{
            "description":"activate writing of comma delimited records",
            "type":"boolean"
        },
        "max-file-size":{
            "description":"maximum file size (bytes), should be >= 1048576 bytes and <= 1073741824 bytes",
            "format":"int64",
            "maximum":1073741824,
            "minimum":1048576,
            "type":"integer"
        },
        "file-sequence-number":{
            "description":"append 9-digit sequence number to CDR file names",
            "type":"boolean"
        },
        "file-rotate-time":{
            "description":"file rotation/push interval (minutes) (0 disables)",
            "format":"int32",
            "maximum":2147483647,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure Quality of Service accounting",
    "type":"object"
}

Nested Schema : cdr-attribute-include-list

Type: array

list of cdr attributes to be included in accounting file

Show Source

• Array of: string
  Allowed Values: [ "Access_Network_Information", "Accounting_Session_ID", "Accounting_Session_Time", "Accounting_Status", "Accounting_Termination_Cause", "ApplicationId", "Associated_URI", "Called_Asserted_Identity", "Called_MOS", "Called_R_Factor", "Called_Station_ID", "Calling_MOS", "Calling_R_Factor", "Calling_Station_ID", "Cause_Code", "CDR_Sequence_Number", "Charging_Function_Address", "Charging_Vector_ICID", "Cisco_Connect_Time", "Cisco_Disconnect_Cause", "Cisco_Disconnect_Time", "Cisco_Setup_Time", "Content_Disposition", "Custom_VSA_200", "Custom_VSA_201", "Custom_VSA_202", "Custom_VSA_203", "Custom_VSA_204", "Custom_VSA_205", "Custom_VSA_206", "Custom_VSA_207", "Custom_VSA_208", "Custom_VSA_209", "Custom_VSA_210", "Custom_VSA_211", "Custom_VSA_212", "Custom_VSA_213", "Custom_VSA_214", "Custom_VSA_215", "Custom_VSA_216", "Custom_VSA_217", "Custom_VSA_218", "Custom_VSA_219", "Custom_VSA_220", "Custom_VSA_221", "Custom_VSA_222", "Custom_VSA_223", "Custom_VSA_224", "Custom_VSA_225", "Custom_VSA_226", "Custom_VSA_227", "Custom_VSA_228", "Custom_VSA_229", "Custom_VSA_230", "Destination_Host", "Destination_Realm", "Diam_Session_Id", "Disconnect_Cause", "Disconnect_Initiator", "Early_SDP_Media", "Early_SDP_Type", "Egress_Local_Address", "Egress_Network_Interface_ID", "Egress_Realm", "Egress_Remote_Address", "Egress_Routing_Number", "Egress_RPH", "Egress_Session_ID", "Egress_Vlan_Tag_Value", "Event", "Event_Time", "Expires", "Firmware_Version", "FS1_Called_Media_Stop_Time", "FS1_Calling_Media_Stop_Time", "FS1_F_Flow_Identifier", "FS1_F_Flow_Input_Dest_Address", "FS1_F_Flow_Input_Dest_Port", "FS1_F_Flow_Input_Realm", "FS1_F_Flow_Input_Src_Addr", "FS1_F_Flow_Input_Src_Port", "FS1_F_Flow_Media_Type", "FS1_F_Flow_Output_Dest_Addr", "FS1_F_Flow_Output_Dest_Port", "FS1_F_Flow_Output_Realm", "FS1_F_Flow_Output_Src_Address", "FS1_F_Flow_Output_Src_Port", "FS1_F_Flow_Type", "FS1_R_Flow_Identifier", "FS1_R_Flow_Input_Dest_Address", "FS1_R_Flow_Input_Dest_Port", "FS1_R_Flow_Input_Realm", "FS1_R_Flow_Input_Src_Addr", "FS1_R_Flow_Input_Src_Port", "FS1_R_Flow_Media_Type", "FS1_R_Flow_Output_Dest_Addr", "FS1_R_Flow_Output_Dest_Port", "FS1_R_Flow_Output_Realm", "FS1_R_Flow_Output_Src_Address", "FS1_R_Flow_Output_Src_Port", "FS1_R_Flow_Type", "FS1_RTCP_Called_Avg_Jitter", "FS1_RTCP_Called_Avg_Latency", "FS1_RTCP_Called_Max_Jitter", "FS1_RTCP_Called_Max_Latency", "FS1_RTCP_Called_Packets_Lost", "FS1_RTCP_Calling_Avg_Jitter", "FS1_RTCP_Calling_Avg_Latency", "FS1_RTCP_Calling_Max_Jitter", "FS1_RTCP_Calling_Max_Latency", "FS1_RTCP_Calling_Packets_Lost", "FS1_RTP_Called_Avg_Jitter", "FS1_RTP_Called_Max_Jitter", "FS1_RTP_Called_Octets", "FS1_RTP_Called_Octets_Transmitted", "FS1_RTP_Called_Packets", "FS1_RTP_Called_Packets_Lost", "FS1_RTP_Called_Packets_Transmitted", "FS1_RTP_Calling_Avg_Jitter", "FS1_RTP_Calling_Max_Jitter", "FS1_RTP_Calling_Octets", "FS1_RTP_Calling_Octets_Transmitted", "FS1_RTP_Calling_Packets", "FS1_RTP_Calling_Packets_Lost", "FS1_RTP_Calling_Packets_Transmitted", "FS2_Called_Media_Stop_Time", "FS2_Calling_Media_Stop_Time", "FS2_F_Flow_Identifier", "FS2_F_Flow_Input_Dest_Address", "FS2_F_Flow_Input_Dest_Port", "FS2_F_Flow_Input_Realm", "FS2_F_Flow_Input_Src_Addr", "FS2_F_Flow_Input_Src_Port", "FS2_F_Flow_Media_Type", "FS2_F_Flow_Output_Dest_Addr", "FS2_F_Flow_Output_Dest_Port", "FS2_F_Flow_Output_Realm", "FS2_F_Flow_Output_Src_Address", "FS2_F_Flow_Output_Src_Port", "FS2_F_Flow_Type", "FS2_R_Flow_Identifier", "FS2_R_Flow_Input_Dest_Address", "FS2_R_Flow_Input_Dest_Port", "FS2_R_Flow_Input_Realm", "FS2_R_Flow_Input_Src_Addr", "FS2_R_Flow_Input_Src_Port", "FS2_R_Flow_Media_Type", "FS2_R_Flow_Output_Dest_Addr", "FS2_R_Flow_Output_Dest_Port", "FS2_R_Flow_Output_Realm", "FS2_R_Flow_Output_Src_Address", "FS2_R_Flow_Output_Src_Port", "FS2_R_Flow_Type", "FS2_RTCP_Called_Avg_Jitter", "FS2_RTCP_Called_Avg_Latency", "FS2_RTCP_Called_Max_Jitter", "FS2_RTCP_Called_Max_Latency", "FS2_RTCP_Called_Packets_Lost", "FS2_RTCP_Calling_Avg_Jitter", "FS2_RTCP_Calling_Avg_Latency", "FS2_RTCP_Calling_Max_Jitter", "FS2_RTCP_Calling_Max_Latency", "FS2_RTCP_Calling_Packets_Lost", "FS2_RTP_Called_Avg_Jitter", "FS2_RTP_Called_Max_Jitter", "FS2_RTP_Called_Octets", "FS2_RTP_Called_Octets_Transmitted", "FS2_RTP_Called_Packets", "FS2_RTP_Called_Packets_Lost", "FS2_RTP_Called_Packets_Transmitted", "FS2_RTP_Calling_Avg_Jitter", "FS2_RTP_Calling_Max_Jitter", "FS2_RTP_Calling_Octets", "FS2_RTP_Calling_Octets_Transmitted", "FS2_RTP_Calling_Packets", "FS2_RTP_Calling_Packets_Lost", "FS2_RTP_Calling_Packets_Transmitted", "Generic_ID", "History_Info", "IMEI", "IMSI", "Ingress_Local_Address", "Ingress_Network_Interface_ID", "Ingress_Realm", "Ingress_Remote_Address", "Ingress_RPH", "Ingress_Session_ID", "Ingress_Vlan_Tag_Value", "Intermediate_Time", "Local_timezone", "MSRP_Called_Octets", "MSRP_Called_Octets_Transmitted", "MSRP_Called_Packets", "MSRP_Called_Packets_Transmitted", "MSRP_Calling_Octets", "MSRP_Calling_Octets_Transmitted", "MSRP_Calling_Packets", "MSRP_Calling_Packets_Transmitted", "NAS_IP_Address", "NAS_Port", "Node_Func", "Node_Functionality", "ORIG_IOI", "Origin_Host", "Origin_Realm", "Originating_Trunk_Context", "Originating_Trunk_Group", "Originator", "P_Asserted_ID", "P_Visited_Network_ID", "PGW_IP_Address", "Post_Dial_Delay", "Primary_routing_Number", "refer_call_transfer_ID", "Role_Of_Node", "SDP_Answer_Timestamp", "SDP_Media", "SDP_Offer_Timestamp", "SDP_Type", "Served_Party_IP", "Service_Context_ID", "Session_Disposition", "Session_Forked_Call_Id", "Session_Protocol_Type", "SGW_IP_Address", "SIP_DIVERSION", "Sip_Method", "Sip_Status_Code", "Sms_Called_Party_Number", "Sms_Calling_Party_Number", "Sms_Msg_length", "Sms_Msg_Type", "Stir_Div_Signed_Request", "Stir_Div_Verified_Request", "Stir_Signed_Request", "Stir_Signed_Request_Exception_Id", "Stir_TN_Used_For_AS_VS_Request", "Stir_Verified_Request", "Stir_Verified_Request_Exception_Id", "Stir_VS_Invite_State", "Stir_VS_Reason", "Stir_VS_Verstat", "Subscription_ID_Data", "Subscription_ID_Type", "TERM_IOI", "Terminating_Trunk_Context", "Terminating_Trunk_Group", "User_Name" ]

{
    "description":"list of cdr attributes to be included in accounting file",
    "items":{
        "$ref":"#/components/schemas/CdrAttrEnum"
    },
    "type":"array"
}

Nested Schema : generate-event

Type: array

list of events like REGISTER, MESSAGE to collect. To disable leave blank (default)

Show Source

• Array of: string
  Allowed Values: [ "Register", "Local-Register", "message" ]

{
    "description":"list of events like REGISTER, MESSAGE to collect. To disable leave blank (default)",
    "items":{
        "$ref":"#/components/schemas/AcctEventEventEnum"
    },
    "type":"array"
}

Nested Schema : generate-interim

Type: array

list of events to collect during a session

Show Source

• Array of: string
  Allowed Values: [ "OK", "Reinvite", "Reinvite-Response", "Reinvite-Cancel", "Unsuccessful-Attempt", "Redirect", "Egress-Invite" ]

{
    "description":"list of events to collect during a session",
    "items":{
        "$ref":"#/components/schemas/AcctInterimEventConstraintEnum"
    },
    "type":"array"
}

404 Response

Not Found

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

{
    "items":{
        "$ref":"#/components/schemas/Errors"
    },
    "type":"array"
}

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

406 Response

Validation Failure

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

{
    "items":{
        "$ref":"#/components/schemas/Errors"
    },
    "type":"array"
}

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top