Yay.com loading

Loading

Phone Calls & CDR Data

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Call Recording Retention

Commands to manage the call recording retention period for an account

Get your free API Key

Filter:

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

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

  • GET/voip/call-retention

    Gets the current retention setting for an account

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    Response Details

    200 Response

    {
        "result" : {
            "expires_in" : 3
        },
        "status_code" : 200,
        "status_message" : "OK"
    }
  • Chargeable *

    PUT/voip/call-retention

    Updates the call retention period for an account

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    PUT body

    • Name

    • Type

    • Required

      • expires_in

      • int

      • True

      The call recording retention period in years

    JSON all-fields example:

    {
        "expires_in" : 3
    }

    Response Details

    200 Response

    {
        "result" : {
            "expires_in" : 3
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

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