Edit CDR Download Setting (v2.0)

Edit CDR download setting.

Note:
  • This documentation applies to API version 2.0.
  • To use this API, upgrade PBX to version 37.23.0.123 or later.

Request URL

POST {base_url}/{api_path}/cdr/updatedownloadoption?access_token={access_token}

Request parameters

Parameter Required Type Description
range No String The download range for CDR.
Valid values:
  • list: Only list data.
  • transaction: Only call leg data.
  • list_transaction: List and call leg data.
  • all: List, call leg, and timeline data.
format No String The download format for CDR.

Valid values:

  • csv
  • xls
  • pdf
  • html
duration_format No String The display format for all duration-related fields.

Valid values:

  • seconds
  • hhmmss
export_column No String The fields to export.

Valid values:

  • all
  • selected

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.

Examples

Request example

POST /openapi/v2.0/cdr/updatedownloadoption?access_token=MVbQu2Fpe1DLOwaYJtAIwAJmWthfPTP8 HTTP/1.1 
Host: 192.168.5.150:8088
Content-Type:  application/json
{
  "format": "csv"
}

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}