Get CDR Exports#

Description

Returns a collection of CDR Exports.

Forming Request#

Request Method: GET

Request Path: /v3/cdr_exports

URI Parameters:

Name

Type

Is Required?

Description

sort

string

Optional

Sorting

Sorting:

Value

Sorts by:

status

The status field.

created_at

The created_at field.

Sparse Fieldsets:

Value

Returns:

filters

The filters attribute.

status

The status attribute.

created_at

The created_at attribute.

url

The url attribute.

callback_url

The callback_url attribute.

callback_method

The callback_method attribute.

Example#

http

1GET /v3/cdr_exports HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]

curl

1curl -i -X GET https://api.didww.com/v3/cdr_exports -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": [
 6    {
 7      "id": "47b08cb8-497a-491c-8263-323498d8bca3",
 8      "type": "cdr_exports",
 9      "attributes": {
10        "filters": {
11          "year": "2017",
12          "month": "3"
13        },
14        "status": "Completed",
15        "created_at": "2017-06-25T14:56:31.513Z",
16        "url": "https://api.didww.com/v3/cdr_exports/a4f6b765-f20c-45c7-98d2-80c2f3a41517.csv"
17      }
18    },
19    {
20      "id": "62b9a23f-4f54-4da1-9b29-c0f6e1b68a3e",
21      "type": "cdr_exports",
22      "attributes": {
23        "filters": {
24          "year": "2017",
25          "month": "4"
26        },
27        "status": "Processing",
28        "created_at": "2017-06-26T14:56:31.513Z",
29        "url": null
30      }
31    },
32    {
33      "id": "77d59bda-33e5-441b-8d38-cc3f0045c673",
34      "type": "cdr_exports",
35      "attributes": {
36        "filters": {
37          "year": "2017",
38          "month": "5"
39        },
40        "status": "Pending",
41        "created_at": "2017-06-26T14:56:31.513Z",
42        "url": null
43      }
44    }
45  ],
46  "meta": {
47    "total_records": 3
48  }
49}

Other Responses#

Code

Success

Description

401

No

Unauthorized