Create Export

Attention

Please note that the Inbound/Outbound CDR export is available for current + 2 last months.

Description

Creates a single Export. DIDWW performs deletion of CDR Export in 1 month after completion.

Forming Request

Request Method: POST

Request Path: /v3/exports

Request Body Object Attributes

Name

Type

Nullable

Is Required?

Description

filters

CDR Export Filters Object

False

Yes

Filters

callback_url

string

True

Optional

The HTTP or HTTPS endpoint to where events related to export will be delivered.

callback_method

string

True

Optional

The HTTP Method used for export events. POST, GET are supported methods.

See Callback details for information about callback_url and callback_method.

Export Type Attributes:

Name

Type

Is Required?

Description

year

integer

Yes

Year of the CDR timestamp.

month

integer

Yes

Month of the CDR timestamp.

did_number

string

Yes

DID number.

Name

Type

Is Required?

Description

year

integer

Yes

Year of the CDR timestamp.

month

integer

Yes

Month of the CDR timestamp.

day

integer

Yes

Day of the CDR timestamp.

voice_out_trunk.id

string

Yes

ID of voice out trunk

Example

http

POST /v3/exports HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

{
  "data": {
    "type": "exports",
    "attributes": {
      "export_type": "cdr_in",
      "filters": {
        "year": "2021",
        "month": "12",
        "did_number": "123456789"
      }
    }
  }
}

curl

curl -i -X POST https://api.didww.com/v3/exports -H 'Accept: application/vnd.api+json' -H 'Api-Key: [API token]' -H 'Content-Type: application/vnd.api+json' --data-raw '{"data": {"attributes": {"export_type": "cdr_in", "filters": {"did_number": "123456789", "month": "12", "year": "2021"}}, "type": "exports"}}'

response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "33bdfff7-4de3-4c58-8c90-b99930fb984a",
    "type": "exports",
    "attributes": {
      "status": "Pending",
      "created_at": "2021-12-16T06:39:44.465Z",
      "url": null,
      "callback_url": null,
      "callback_method": null,
      "export_type": "cdr_in"
    }
  },
  "meta": {
    "api_version": "2021-12-15"
  }
}

http

POST /v3/exports HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

{
  "data": {
    "type": "exports",
    "attributes": {
      "callback_url": "http://10.201.10.1/test.php",
      "callback_method": "GET",
      "export_type": "cdr_in",
      "filters": {
        "year": "2021",
        "month": "12",
        "did_number": "123456789"
      }
    }
  }
}

curl

curl -i -X POST https://api.didww.com/v3/exports -H 'Accept: application/vnd.api+json' -H 'Api-Key: [API token]' -H 'Content-Type: application/vnd.api+json' --data-raw '{"data": {"attributes": {"callback_method": "GET", "callback_url": "http://10.201.10.1/test.php", "export_type": "cdr_in", "filters": {"did_number": "123456789", "month": "12", "year": "2021"}}, "type": "exports"}}'

response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "d4f37476-8ece-4add-bbcb-cc72a7908fe2",
    "type": "exports",
    "attributes": {
      "status": "Pending",
      "created_at": "2021-12-16T06:54:30.122Z",
      "url": null,
      "callback_url": "http://10.201.10.1/test.php",
      "callback_method": "GET",
      "export_type": "cdr_in"
    }
  },
  "meta": {
    "api_version": "2021-12-15"
  }
}

http

POST /v3/exports HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

{
  "data": {
    "type": "exports",
    "attributes": {
      "export_type": "cdr_out",
      "filters": {
        "year": "2021",
        "month": "12",
        "day": "12",
        "voice_out_trunk.id": "457bf47d-446d-41cd-91c3-dfbda7bf0753"
      }
    }
  }
}

curl

curl -i -X POST https://api.didww.com/v3/exports -H 'Accept: application/vnd.api+json' -H 'Api-Key: [API token]' -H 'Content-Type: application/vnd.api+json' --data-raw '{"data": {"attributes": {"export_type": "cdr_out", "filters": {"day": "12", "month": "12", "voice_out_trunk.id": "457bf47d-446d-41cd-91c3-dfbda7bf0753", "year": "2021"}}, "type": "exports"}}'

response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "88a29a27-11fe-4db0-a508-eca1d7cf0b68",
    "type": "exports",
    "attributes": {
      "status": "Pending",
      "created_at": "2021-12-21T07:37:13.085Z",
      "url": null,
      "callback_url": null,
      "callback_method": null,
      "export_type": "cdr_out"
    }
  },
  "meta": {
    "api_version": "2021-12-15"
  }
}

http

POST /v3/exports HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

{
  "data": {
    "type": "exports",
    "attributes": {
      "export_type": "cdr_out",
      "callback_url": "http://10.201.10.1/test.php",
      "callback_method": "GET",
      "filters": {
        "year": "2021",
        "month": "12",
        "day": "12",
        "voice_out_trunk.id": "457bf47d-446d-41cd-91c3-dfbda7bf0753"
      }
    }
  }
}

curl

curl -i -X POST https://api.didww.com/v3/exports -H 'Accept: application/vnd.api+json' -H 'Api-Key: [API token]' -H 'Content-Type: application/vnd.api+json' --data-raw '{"data": {"attributes": {"callback_method": "GET", "callback_url": "http://10.201.10.1/test.php", "export_type": "cdr_out", "filters": {"day": "12", "month": "12", "voice_out_trunk.id": "457bf47d-446d-41cd-91c3-dfbda7bf0753", "year": "2021"}}, "type": "exports"}}'

response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "67e4f27f-d5eb-4b80-8924-39486aee6ed4",
    "type": "exports",
    "attributes": {
      "status": "Pending",
      "created_at": "2021-12-21T07:42:02.546Z",
      "url": null,
      "callback_url": "http://10.201.10.1/test.php",
      "callback_method": "GET",
      "export_type": "cdr_out"
    }
  },
  "meta": {
    "api_version": "2021-12-15"
  }
}

http

POST /v3/exports HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

{
  "data": {
    "type": "exports",
    "attributes": {
        "export_type": "cdr_out",
      "filters": {
        "year": "2021",
        "month": "12",
        "voice_out_trunk.id": "457bf47d-446d-41cd-91c3-dfbda7bf0753"
      }
    }
  }
}

curl

curl -i -X POST https://api.didww.com/v3/exports -H 'Accept: application/vnd.api+json' -H 'Api-Key: [API token]' -H 'Content-Type: application/vnd.api+json' --data-raw '{"data": {"attributes": {"export_type": "cdr_out", "filters": {"month": "12", "voice_out_trunk.id": "457bf47d-446d-41cd-91c3-dfbda7bf0753", "year": "2021"}}, "type": "exports"}}'

response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
   "data":    {
      "id": "88a29a27-11fe-4db0-a508-eca1d7cf0b68",
      "type": "exports",
      "attributes":       {
         "status": "Pending",
         "created_at": "2021-12-21T07:37:13.085Z",
         "url": null,
         "callback_url": null,
         "callback_method": null,
         "export_type": "cdr_out"
      }
   },
   "meta": {"api_version": "2021-12-15"}
}

Other Responses

Code

Success

Description

422

No

Unprocessable Entity

401

No

Unauthorized