Call Detail Records | PortSIP Knowledge Base

List CDRs

get

Retrieve a collection of call detail records.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/cdrs

GET /api/cdrs HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller": "text",
      "caller_domain": "text",
      "caller_display_name": "text",
      "callee": "text",
      "callee_domain": "text",
      "callee_display_name": "text",
      "started_at": "2017-07-21T17:32:28Z",
      "rang_at": "2017-07-21T17:32:28Z",
      "answered_at": "2017-07-21T17:32:28Z",
      "ended_at": "2017-07-21T17:32:28Z",
      "call_id": "text",
      "direction": "INBOUND_CALL",
      "end_reason": "CALLER_DISCONNECTED",
      "reroute_reason": "TRANSFER",
      "status_code": 1,
      "destination": "text",
      "outbound_caller_id": "text",
      "did_cid": "text",
      "trunk": "text",
      "duration": 1,
      "service_number": "text",
      "user_data": "text"
    }
  ]
}

Retrieve CDR detailed information.

get

Retrieve details of CDR.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of CDR.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/cdrs/{id}

GET /api/cdrs/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "caller": "text",
      "caller_domain": "text",
      "caller_display_name": "text",
      "callee": "text",
      "callee_domain": "text",
      "callee_display_name": "text",
      "started_at": "2017-07-21T17:32:28Z",
      "rang_at": "2017-07-21T17:32:28Z",
      "answered_at": "2017-07-21T17:32:28Z",
      "ended_at": "2017-07-21T17:32:28Z",
      "call_id": "text",
      "direction": "INBOUND_CALL",
      "end_reason": "CALLER_DISCONNECTED",
      "reroute_reason": "TRANSFER",
      "status_code": 1,
      "destination": "text",
      "outbound_caller_id": "text",
      "did_cid": "text",
      "trunk": "text",
      "duration": 1,
      "cost": 1,
      "billed_account": "text",
      "service_number": "text",
      "user_data": "text"
    }
  ]
}

List call logs

get

Retrieve a collection of call logs.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/calllogs

GET /api/calllogs HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "session_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller": "text",
      "caller_domain": "text",
      "caller_display_name": "text",
      "callee": "text",
      "callee_domain": "text",
      "callee_display_name": "text",
      "started_at": "2017-07-21T17:32:28Z",
      "rang_at": "2017-07-21T17:32:28Z",
      "answered_at": "2017-07-21T17:32:28Z",
      "ended_at": "2017-07-21T17:32:28Z",
      "call_id": "text",
      "direction": "INBOUND_CALL",
      "end_reason": "CALLER_DISCONNECTED",
      "reroute_reason": "TRANSFER",
      "status_code": 1,
      "destination": "text",
      "outbound_caller_id": "text",
      "did_cid": "text",
      "trunk": "text",
      "duration": 1,
      "service_number": "text",
      "user_data": "text"
    }
  ]
}

Retrieve call log detailed information.

get

Retrieve details of call log.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of CDR.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of CDR.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

session_idall ofOptional

The session ID of call log.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

callerstring · max: 256Optional

The caller number of the call.

caller_domainstring · max: 1024Optional

The caller domain of the call.

caller_display_namestring · max: 1024Optional

The caller display name of the call.

calleestring · max: 256Optional

The callee number of the call.

callee_domainstring · max: 1024Optional

The callee domain of the call.

callee_display_namestring · max: 1024Optional

The callee display name of the call.

started_atall ofOptional

The start time of the call.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

rang_atall ofOptional

The ringing time of the call.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

answered_atall ofOptional

The answer time of the call.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

ended_atall ofOptional

The end time of the call.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

call_idstringOptional

The call ID of CDR.

directionstring · enumOptional

The direction of CDR:

INBOUND_CALL:
OUTBOUND_CALL:
EXTENSION_CALL:
INBOUND_OUTBOUND_CALL:

Possible values:

end_reasonstring · enumOptional

The ended reason of CDR:
Can be either:

CALLER_DISCONNECTED:
CALLEE_DISCONNECTED:
BLIND_TRANSFER_COMPLETED:
CONSULT_TRANSFER_COMPLETED:
REPLACED:
REFERRED:
REDIRECTED:
CANCELLED:

Possible values:

reroute_reasonstring · enumOptional

The reroute reason of CDR:
Can be either:

TRANSFER:
OVERFLOW:

Possible values:

status_codeintegerOptional

The status code of CDR.

destinationstringOptional

The destination number of CDR.

outbound_caller_idstring · min: 1 · max: 64Optional

Outbound caller id.

did_cidstringOptional

The DID CID of CDR.

trunkstringOptional

The trunk name of CDR.

durationinteger · int32Optional

The total talk time for a session (in seconds).

costnumber · doubleOptional

The cost for this call.

billed_accountstringOptional

The account name for billing.

service_numberstringOptional

The service number of the call.

user_datastringOptional

The additional custom user data of CDR.

4XX

Error

get

/calllogs/{id}

GET /api/calllogs/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "session_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "caller": "text",
  "caller_domain": "text",
  "caller_display_name": "text",
  "callee": "text",
  "callee_domain": "text",
  "callee_display_name": "text",
  "started_at": "2017-07-21T17:32:28Z",
  "rang_at": "2017-07-21T17:32:28Z",
  "answered_at": "2017-07-21T17:32:28Z",
  "ended_at": "2017-07-21T17:32:28Z",
  "call_id": "text",
  "direction": "INBOUND_CALL",
  "end_reason": "CALLER_DISCONNECTED",
  "reroute_reason": "TRANSFER",
  "status_code": 1,
  "destination": "text",
  "outbound_caller_id": "text",
  "did_cid": "text",
  "trunk": "text",
  "duration": 1,
  "cost": 1,
  "billed_account": "text",
  "service_number": "text",
  "user_data": "text"
}

List call reports

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/call_reports

GET /api/call_reports HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "type": "NORMAL",
      "cron_expr": "text",
      "status": "RUNNING"
    }
  ]
}

Create new call report

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestringRequired

The name of call report.

typestring · enumRequired

The report types can be either:

NORMAL:
EXTENSION_GROUP_CALL_COST:
QUEUE_PERFORMANCE:
QUEUE_DETAILED_STATISTICS:
QUEUE_ABANDONED_CALLS:
QUEUE_SLA_STATISTICS:
QUEUE_BREACHES_SLA_STATISTICS:
QUEUE_CALLBACKS:
QUEUE_FAILED_CALLBACKS:
TEAM_QUEUE_GENERAL_STATISTICS:
RING_GROUP_STATISTICS:

Possible values:

emailall ofRequired

The email address to which the report file will be sent after the report is complete.

string · max: 128Optional

The email address.

Example: [email protected]

formatstring · enumRequired

The report output files format can be either:

CSV:
HTML:

Possible values:

rangestring · enumRequired

The report range can be either:

TODAY: the day the report was generated.
YESTERDAY: yesterday of the day the report was generated.
LAST_WEEK: the last week of the day the report was generated.
LAST_SEVEN_DAYS: seven days before the day the report was generated.
LAST_MONTH: the last month of the day the report was generated.
LAST_THIRTY_DAYS: thirty days before the day the report was generated.
CUSTOM: custom date range.

Possible values:

started_atall ofOptional

Filter data after specified data time.
Only valid when the range is specified as CUSTOM

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

ended_atall ofOptional

Filter data before specified data time.
Only valid when the range is specified as CUSTOM

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

cron_exprstringOptional

The crontab expression https://en.wikipedia.org/wiki/Cron

filterone ofRequired

or

Responses

201

Created

application/json

4XX

Error

post

/call_reports

POST /api/call_reports HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 326

{
  "name": "text",
  "type": "NORMAL",
  "email": "[email protected]",
  "format": "CSV",
  "range": "TODAY",
  "started_at": "2017-07-21T17:32:28Z",
  "ended_at": "2017-07-21T17:32:28Z",
  "cron_expr": "text",
  "filter": {
    "from": "ANY",
    "from_value": "text",
    "to": "ANY",
    "to_value": "text",
    "answer_state": "ANY",
    "duration": "ANY",
    "duration_from": 1,
    "duration_to": 1
  }
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Get call report details

get

Get details of call report by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of this call report.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of this call report.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

namestringOptional

The name of call report.

typestring · enumOptional

The report types can be either:

NORMAL:
EXTENSION_GROUP_CALL_COST:
QUEUE_PERFORMANCE:
QUEUE_DETAILED_STATISTICS:
QUEUE_ABANDONED_CALLS:
QUEUE_SLA_STATISTICS:
QUEUE_BREACHES_SLA_STATISTICS:
QUEUE_CALLBACKS:
QUEUE_FAILED_CALLBACKS:
TEAM_QUEUE_GENERAL_STATISTICS:
RING_GROUP_STATISTICS:

Possible values:

emailall ofOptional

The email address to which the report file will be sent after the report is complete.

string · max: 128Optional

The email address.

Example: [email protected]

formatstring · enumOptional

The report output files format can be either:

CSV:
HTML:

Possible values:

rangestring · enumOptional

The report range can be either:

TODAY: the day the report was generated.
YESTERDAY: yesterday of the day the report was generated.
LAST_WEEK: the last week of the day the report was generated.
LAST_SEVEN_DAYS: seven days before the day the report was generated.
LAST_MONTH: the last month of the day the report was generated.
LAST_THIRTY_DAYS: thirty days before the day the report was generated.
CUSTOM: custom date range.

Possible values:

started_atall ofOptional

Filter data after specified data time.
Only valid when the range is specified as CUSTOM

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

ended_atall ofOptional

Filter data before specified data time.
Only valid when the range is specified as CUSTOM

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

cron_exprstringOptional

The crontab expression https://en.wikipedia.org/wiki/Cron

filterone ofOptional

or

statusstring · enumOptional

The report status can be either:

RUNNING:
SCHEDULED:
ABORTED:

Possible values:

4XX

Error

get

/call_reports/{id}

GET /api/call_reports/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "type": "NORMAL",
  "email": "[email protected]",
  "format": "CSV",
  "range": "TODAY",
  "started_at": "2017-07-21T17:32:28Z",
  "ended_at": "2017-07-21T17:32:28Z",
  "cron_expr": "text",
  "filter": {
    "from": "ANY",
    "from_value": "text",
    "to": "ANY",
    "to_value": "text",
    "answer_state": "ANY",
    "duration": "ANY",
    "duration_from": 1,
    "duration_to": 1
  },
  "status": "RUNNING"
}

Update call report

post

Update call report properties.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of this call report.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

namestringOptional

The name of call report.

emailall ofOptional

The email address to which the report file will be sent after the report is complete.

string · max: 128Optional

The email address.

Example: [email protected]

formatstring · enumOptional

The report output files format can be either:

CSV:
HTML:

Possible values:

rangestring · enumOptional

The report range can be either:

TODAY: the day the report was generated.
YESTERDAY: yesterday of the day the report was generated.
LAST_WEEK: the last week of the day the report was generated.
LAST_SEVEN_DAYS: seven days before the day the report was generated.
LAST_MONTH: the last month of the day the report was generated.
LAST_THIRTY_DAYS: thirty days before the day the report was generated.
CUSTOM: custom date range.

Possible values:

started_atall ofOptional

Filter data after specified data time.
Only valid when the range is specified as CUSTOM

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

ended_atall ofOptional

Filter data before specified data time.
Only valid when the range is specified as CUSTOM

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

cron_exprstringOptional

The crontab expression https://en.wikipedia.org/wiki/Cron

filterone ofOptional

or

Responses

200

OK

No content

4XX

Error

post

/call_reports/{id}

POST /api/call_reports/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 310

{
  "name": "text",
  "email": "[email protected]",
  "format": "CSV",
  "range": "TODAY",
  "started_at": "2017-07-21T17:32:28Z",
  "ended_at": "2017-07-21T17:32:28Z",
  "cron_expr": "text",
  "filter": {
    "from": "ANY",
    "from_value": "text",
    "to": "ANY",
    "to_value": "text",
    "answer_state": "ANY",
    "duration": "ANY",
    "duration_from": 1,
    "duration_to": 1
  }
}

No content

Destroy call report

post

Destroy call report by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of this call report.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

400

Invalid entry ID supplied

post

/call_reports/{id}/destroy

POST /api/call_reports/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List completed call reports

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/completed_call_reports

GET /api/completed_call_reports HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "type": "NORMAL",
      "format": "CSV",
      "completed_at": "2017-07-21T17:32:28Z",
      "file_name": "text",
      "file_size": 0,
      "file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
    }
  ]
}

Get completed call report details

get

Get details of completed call report by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of this call report.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of this call report.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

namestringOptional

The name of call report.

typestring · enumOptional

The report types can be either:

NORMAL:
EXTENSION_GROUP_CALL_COST:
QUEUE_PERFORMANCE:
QUEUE_DETAILED_STATISTICS:
QUEUE_ABANDONED_CALLS:
QUEUE_SLA_STATISTICS:
QUEUE_BREACHES_SLA_STATISTICS:
QUEUE_CALLBACKS:
QUEUE_FAILED_CALLBACKS:
TEAM_QUEUE_GENERAL_STATISTICS:
RING_GROUP_STATISTICS:

Possible values:

formatstring · enumOptional

The report output files format can be either:

CSV:
HTML:

Possible values:

completed_atall ofOptional

The completed time of call report.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

file_namestringOptional

The name of the file.

file_sizeinteger · int64Optional

The file size in bytes.

Example: 0

file_urlstringRead-onlyOptional

The relative path to file url for file downloading.

Example: /api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK

4XX

Error

get

/completed_call_reports/{id}

GET /api/completed_call_reports/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "type": "NORMAL",
  "format": "CSV",
  "completed_at": "2017-07-21T17:32:28Z",
  "file_name": "text",
  "file_size": 0,
  "file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
}

Destroy completed call report

post

Destroy completed call report by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of this call report.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

400

Invalid entry ID supplied

post

/completed_call_reports/{id}/destroy

POST /api/completed_call_reports/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

hashtagList CDRs

hashtagRetrieve CDR detailed information.

hashtagList call logs

hashtagRetrieve call log detailed information.

hashtagList call reports

hashtagCreate new call report

hashtagGet call report details

hashtagUpdate call report

hashtagDestroy call report

hashtagList completed call reports

hashtagGet completed call report details

hashtagDestroy completed call report

List CDRs

Retrieve CDR detailed information.

List call logs

Retrieve call log detailed information.

List call reports

Create new call report

Get call report details

Update call report

Destroy call report

List completed call reports

Get completed call report details

Destroy completed call report