Yay.com loading

Loading

Error Sorry

0

Shopping Basket

Basket Total

$0.00

incVAT

Delete everything from your basket?

Go to Checkout

Call Statistics Reporting

A Call Statistics Report configures a scheduled report that will be emailed to recipients at the sspecified time

Become a Reseller

Filter:

  • All
  • GET
  • POST
  • PUT
  • DELETE
  • Chargeable *

* You will be charged every time this command is run.

  • GET/voip/call/statistics/schedule

    Returns all the currently configured reporting schedules for the account

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    Response Details

    200 Response

    {
        "result" : [
            {
                "history" : [
                    {}
                ],
                "nickname" : "Daily sales group report",
                "objects" : [
                    {
                        "type" : "group",
                        "uuid" : "e1214afa-364a-4be0-b25a-28a988e633bb"
                    }
                ],
                "recipients" : [
                    {
                        "email_address" : "help@yay.com",
                        "send_at" : "10:00:00"
                    }
                ],
                "schedule_type_id" : 1,
                "weekday_only" : true
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/voip/call/statistics/schedule/{uuid}

    Gets the specified Call Statistics Schedule

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Call Statistics Schedule to return

    Response Details

    200 Response

    {
        "result" : {
            "history" : [
                {}
            ],
            "nickname" : "Daily sales group report",
            "objects" : [
                {
                    "type" : "group",
                    "uuid" : "e1214afa-364a-4be0-b25a-28a988e633bb"
                }
            ],
            "recipients" : [
                {
                    "email_address" : "help@yay.com",
                    "send_at" : "10:00:00"
                }
            ],
            "schedule_type_id" : 1,
            "weekday_only" : true
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • POST/voip/call/statistics/schedule

    Creates a new Call Statistics Schedule

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • nickname

      • String

      • True

      The nickname for this Call Statistics Schedule

      • objects

      • Array of CallStatisticScheduleObject

      • True

      The list of SIP users, Hunt Groups and Wallboard that this report will return statistics for

      • recipients

      • Array of CallStatisticScheduleRecipient

      • True

      The list of email addresses that will receive the report

      • schedule_type_id

      • int

      • True

      How often does this report run, valid values are 1 - every day, 2 - weekly, 3 - monthly

      • weekday_only

      • Boolean

      • False

      Should this report run on Weekdays only, this only applies if the daily schedule type is selected

    CallStatisticScheduleRecipient

      • email_address

      • String

      • True

      The email addresses of the user to receive the report

      • send_at

      • String

      • True

      What time of day to send the email, should be in the range 05:00 to 17:00, delivery before 05:00 can't be guaranteed

    CallStatisticScheduleObject

      • type

      • String

      • True

      The type of object represented by the UUID, valid values are user, group, and wallboard

      • uuid

      • String

      • True

      The UUID of the object

    CallStatisticScheduleHistory

    JSON all-fields example:

    {
        "nickname" : "Daily sales group report",
        "objects" : [
            {
                "type" : "group",
                "uuid" : "e1214afa-364a-4be0-b25a-28a988e633bb"
            }
        ],
        "recipients" : [
            {
                "email_address" : "help@yay.com",
                "send_at" : "10:00:00"
            }
        ],
        "schedule_type_id" : 1,
        "weekday_only" : true
    }

    Response Details

    201 Response

    {
        "result" : {
            "history" : [
                {}
            ],
            "nickname" : "Daily sales group report",
            "objects" : [
                {
                    "type" : "group",
                    "uuid" : "e1214afa-364a-4be0-b25a-28a988e633bb"
                }
            ],
            "recipients" : [
                {
                    "email_address" : "help@yay.com",
                    "send_at" : "10:00:00"
                }
            ],
            "schedule_type_id" : 1,
            "weekday_only" : true
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • PUT/voip/call/statistics/schedule/{uuid}

    Updates an existing Call Statistics Schedule

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Call Statistics Schedule to update

    PUT body

    • Name

    • Type

    • Required

      • nickname

      • String

      • True

      The nickname for this Call Statistics Schedule

      • objects

      • Array of CallStatisticScheduleObject

      • True

      The list of SIP users, Hunt Groups and Wallboard that this report will return statistics for

      • recipients

      • Array of CallStatisticScheduleRecipient

      • True

      The list of email addresses that will receive the report

      • schedule_type_id

      • int

      • True

      How often does this report run, valid values are 1 - every day, 2 - weekly, 3 - monthly

      • weekday_only

      • Boolean

      • False

      Should this report run on Weekdays only, this only applies if the daily schedule type is selected

    CallStatisticScheduleRecipient

      • email_address

      • String

      • True

      The email addresses of the user to receive the report

      • send_at

      • String

      • True

      What time of day to send the email, should be in the range 05:00 to 17:00, delivery before 05:00 can't be guaranteed

    CallStatisticScheduleObject

      • type

      • String

      • True

      The type of object represented by the UUID, valid values are user, group, and wallboard

      • uuid

      • String

      • True

      The UUID of the object

    CallStatisticScheduleHistory

    JSON all-fields example:

    {
        "nickname" : "Daily sales group report",
        "objects" : [
            {
                "type" : "group",
                "uuid" : "e1214afa-364a-4be0-b25a-28a988e633bb"
            }
        ],
        "recipients" : [
            {
                "email_address" : "help@yay.com",
                "send_at" : "10:00:00"
            }
        ],
        "schedule_type_id" : 1,
        "weekday_only" : true
    }

    Response Details

    200 Response

    {
        "result" : {
            "history" : [
                {}
            ],
            "nickname" : "Daily sales group report",
            "objects" : [
                {
                    "type" : "group",
                    "uuid" : "e1214afa-364a-4be0-b25a-28a988e633bb"
                }
            ],
            "recipients" : [
                {
                    "email_address" : "help@yay.com",
                    "send_at" : "10:00:00"
                }
            ],
            "schedule_type_id" : 1,
            "weekday_only" : true
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • DELETE/voip/call/statistics/schedule/{uuid}

    Deletes the specified Call Statistics Schedule

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Call Statistics Schedule to delete

    Response Details

    204 Response

    {
        "result" : {},
        "status_code" : 204,
        "status_message" : "No Content"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
ISO 27001 Business Continuity Accreditation ISO 22301 Business Continuity Accreditation Cyber Essentials Certificate of Assurance G-Cloud accredited by the Crown Commercial Service