Report Format

This describes the reports generated by Aculab Cloud.

Unless otherwise documented times are specified in seconds since the Unix epoch UTC, 1st January 1970 00:00, where UTC is the Coordinated Universal Time.

  • HeaderTypeDescription
    Date_Time of recordstringthe date and time of the record in the format YYYY-MM-DD_hh:mm:ss
    Application Instance IDstringthe application instance's unique ID.
    Application Namestringthe name of the application.
    Start Timeintegerthe time the application instance started.
    Start Datetimestringthe time the application instance started formatted as YYYY-MM-DD_hh:mm:ss.
    Stop Timeintegerthe time the application instance stopped.
    Stop Datetimestringthe time the application instance stopped formatted as YYYY-MM-DD_hh:mm:ss.
    Durationfloatthe duration of the application instance in seconds.
    Text-To-Speech secondsfloatthe duration of any Text-To-Speech used in seconds.
    Text-To-Speech Unit Costfloatthe per minute cost of any Text-To-Speech used.
    Extra Channelsintegerthe number of extra channels configured for the application instance.
    Fax enabledstring"true" if fax is enabled on the service. Else "false".
    Platform costfloatthe Aculab Cloud platform cost for the instance.
    Extra channel costfloatthe cost of any extra channel usage.
    PSTN outbound costfloatthe cost of any outbound PSTN telephone calls.
    Text-To-Speech costfloatthe cost of any Text-To-Speech used.
    Toll free costfloatthe cost of any toll free telephone calls.
    Feature secondsfloatthe total duration of any features used in seconds.
    Feature costfloatthe total cost of any features used.
    Total costfloatthe total cost for the application instance
    Costs validstring"true" if the costs provided are valid. Else "false".
    Statusintegerthe numeric return code passed back by the application instance
    Outbound argumentsstringa shortened representation of the outbound parameters passed to the application instance.
    Application argumentsstringa shortened representation of the application parameters sent to the application instance.
    REST Log Filenamestringthe name of the REST log file associated with this instance. Empty for non-REST applications.
    UAS IP Addressstringfor REST applications this returns an empty string. Otherwise it contains the public ip address of the UAS where the application was run.
    UAS Display Namestringfor REST applications this return an empty string. Otherwise it contains the UAS name as set in the UAS Management Console settings page where this application was run.
    REST Destination Addressstringthe to parameter supplied for an outbound REST call. Empty for non-REST or inbound applications.
    REST Originating Addressstringthe from parameter supplied for an outbound REST call. Empty for non-REST or inbound applications.
    REST Initial Tokenstringa shortened representation of the token parameter initially supplied for an outbound REST call. Empty for non-REST or inbound applications.
    Neural Text-To-Speech secondsfloatthe duration of any neural Text-To-Speech used in seconds.
    Neural Text-To-Speech Unit Costfloatthe per minute cost of any neural Text-To-Speech used.
    Neural Text-To-Speech costfloatthe cost of any neural Text-To-Speech used.
  • HeaderTypeDescription
    Date_Time of recordstringthe date and time of the record in the format YYYY-MM-DD_hh:mm:ss
    Call IDstringthe call's unique ID.
    Destination Addressstringthe target destination of the call.
    Originating Addressstringthe address from which the call was made.
    Dirstringthe direction of the call ("in", "out" or "client").
    Typestring"p" for a primary call channel, "x" for an extra channel, "ca" for an audio only WebRTC client call, "cv" for a WebRTC client call with video.
    Initiatedfloatthe time at which the call was placed.
    Initiated Datetimestringthe time at which the call was placed formatted as YYYY-MM-DD_hh:mm:ss.
    Connectedfloatthe time at which the call became connected.
    Connected Datetimestringthe time at which the call became connected formatted as YYYY-MM-DD_hh:mm:ss.
    Hangupfloatthe time at which the call was hung up.
    Hangup Datetimestringthe time at which the call was hung up formatted as YYYY-MM-DD_hh:mm:ss.
    Durationfloatthe duration of the call in seconds.
    Joined timefloatthe duration in seconds for which the call was joined (connected or transferred) to another call.
    Hangup causestringthe reason why the call was disconnected.
    Call costfloatthe cost of the call
    Costs validstring"true" if the costs provided are valid. Else "false".
  • HeaderTypeDescription
    Date_Time of recordstringthe date and time of the record in the format YYYY-MM-DD_hh:mm:ss
    Feature IDstringthe feature's unique ID.
    Audio Pathstringa string describing the audio path of the call to which the feature was applied: "in", "out", "mixed" or "" if not applicable.
    Typestringthe type of feature used.
    Speech Recognition features start with "sr_" and include: "sr_play", "sr_get_input", "sr_run_speech_menu", "sr_start_transcription".
    Speaker Verification features start with "sv_" and include: "sv_register", "sv_verify".
    Initiatedfloatthe time at which the feature started.
    Initiated Datetimestringthe time at which the feature started formatted as YYYY-MM-DD_hh:mm:ss.
    Completedfloatthe time at which the feature stopped.
    Completed Datetimestringthe time at which the feature stopped formatted as YYYY-MM-DD_hh:mm:ss.
    Durationfloatthe duration of the feature in seconds.
    Charged Durationfloatthe duration in seconds that was used to calculate cost.
    Costfloatthe cost of using the feature.
    Unit Costfloatthe per minute cost of using the feature.
    Costs validstring"true" if the costs provided are valid. Else "false".
    Application IDstringthe application instance's unique ID.
    Call IDstringthe call id for the call on which the feature was used.
    Transaction IDstringthe ID of the transaction.
  • HeaderTypeDescription
    Date_Time of recordstringthe date and time of the record in the format YYYY-MM-DD_hh:mm:ss
    Typestringeither "sms" or "mms".
    Directionstring"send" if the message was sent from Aculab Cloud, "receive" if it was received.
    Message Reference IDstringa unique reference ID for this message. If it's a sent message, it was returned by msg_send.
    Statusstringthe message status, such as "submitted to carrier", "sent", "delivered", "accepted", "failed (reason)" or "received". The possible values are described in the status table.
    Finalstring"T" if no more updates will occur. Else "F".
    Costfloatthe cost of the message.
    Fromstringthe number of the phone sending the message. A full international number without any leading +.
    Tostringthe number of the phone receiving the message. A full international number without any leading +.
    Multipart UIDstringan ID for the overall message, shared by all its parts, which is unique among all recent messages in this direction. (Multipart messages only.)
    Multipart positionstringposition of this message part within the overall message, 1...multipart_count. (Multipart messages only.)
    Multipart countstringnumber of message parts within the overall message. (Multipart messages only.)
    Contentstringthe content of your message. If it includes characters not present in standard 7-bit ASCII, they'll be encoded as UTF-8. (Accounts can be configured to omit this. Contact us if you want this omitted)
    Aculab Msg ErrorstringMore detailed information about the status of the message, only available on selected carriers. See the aculab_msg_err table for possible return codes.
    Message media locationstringthe location of any received media files in the message media cloud store.
  • HeaderTypeDescription
    Date_Time of recordstringthe date and time of the record in the format YYYY-MM-DD_hh:mm:ss
    Application Instance IDstringthe unique ID of the application instance that produced the error.
    Error codestringa four digit code for the error.
    Error textstringa textual explanation of the error.
    Error linkstringa link to online documentation for the error code.