Recording server REST Api

This section describes the Recording server API.

In the following, all url are relative to the recording server base url and port. For example a relative URL /records/search is meant to be replaced by http://192.168.29.101:9400/records/search assuming the recording server is available on port 9400 at 192.168.29.101

Authentication

To use the recording api you need to add an additional header in the HTTP Request. The header name is X-Auth-Token and its value must be the same as the authentication.token value in the application.conf of the recording server.

Example:

curl -XPOST -H "Content-Type: application/json" -H "Accept: application/json"
         -H 'X-Auth-Token: u@pf#41[gYHJm<]9N[a0iWDQQ7`e9k'  http://192.168.29.101:9400/records/search?pageSize=3  -d '{"agent": "1573"}'

Records

Search by call id

This api allows to search for a recorded call based on call id.

Description:

URL:

/records/callid_search
Method:

POST
Url parameters:
callid:The call id to retrieve

Example Query:

curl -XPOST -H "Accept: application/json"
          -H 'X-Auth-Token: u@pf#41[gYHJm<]9N[a0iWDQQ7`e9k'  http://192.168.29.101:9400/records/callid_search?callid=1459435466.286075

Response:

{
    "hasNext": false,
    "records": [
        {
            "agent": "Dino Falconetti (1564)",
            "attached_data": {
                "recording": "xivocc_gateway-1459435465.15089"
            },
            "dst_num": "73556",
            "duration": "",
            "id": "xivocc_gateway-1459435465.15089",
            "queue": "hotline (3556)",
            "src_num": "loadtester",
            "start": "2016-03-31 16:44:26",
            "status": "answered"
        }
    ]
}

Retrieve audio file

This api allows to get metadata or retrieve audio file of a given call. Each action performmed will be logged in access log file. See Access logs.

Description:

URL:

/records/records/<file-id>/audio/<action>
Method:

GET
Url parameters:
file-ud:The file to retrieve
action:Action done on the audio file

Allowed actions:

result:To retrieve metadata from a search
listen:To notify that we listened to the file
download:To get the file locally

Example:

curl -XGET -H "Accept: application/json" -H 'X-Auth-Token: u@pf#41[gYHJm<]9N[a0iWDQQ7`e9k'
          http://192.168.29.101:9400/records/xivocc_gateway-1459435465.15089/audio/download

Attach call data

This api allows to attach data to a given call

Description:

URL:

/call_data/<call-data-id>/attached_data
Method:

POST
Url parameters:
call-data-id:The id of the call-data, not to be confused by the call id or unique id.
Request Body:

An array of key value

Example:

curl -XPOST -H "Content-Type: application/json" -H "Accept: application/json" -H 'X-Auth-Token: u@pf#41[gYHJm<]9N[a0iWDQQ7`e9k'
          http://192.168.29.101:9400/call_data/761054/attached_data  -d '[{"key":"color", "value": "green"}]'

History

Search

This api gives the call history of a given interface.

Description:

URL:

/history
Method:

POST
Url parameters:
size:The maximum number of result to return
Request Body:

A json object with a field named interface containing the interface to search for.

Example Query:

curl -XPOST -H "Content-Type: application/json" -H "Accept: application/json" -H 'X-Auth-Token: u@pf#41[gYHJm<]9N[a0iWDQQ7`e9k' http://localhost:9400/history  -d '{"interface":"SIP/az9kf7"}'

Response:

[
 {
  "start": "2017-01-27 15:37:54",
  "duration": "00:00:18",
  "src_num": "1001",
  "dst_num": "3000",
  "status": "emitted",
  "src_firstname": "Poste",
  "src_lastname": "Poste 1001",
  "dst_firstname": null,
  "dst_lastname": "Cars"
 }
]

Search by customer

This api helps to find call history of a customer thanks to a list of predefined filters.

Description:

URL:/history/customer
Method:POST
Request Body:A json object with filters (optional) named filters containing the customer to search for and size to limit the results returned.
Response:total the number of call received by this customer, list the call details reduced to the size set in query.

A filter is composed of a field as key (basically column name), an operator (=, <, >) and a value.

Allowed filter field:

src_num:The customer phone number
key:Call Attached data key
value:Call Attached data value

Example Query:

curl -XPOST -H "Content-Type: application/json" -H "Accept: application/json" -H 'X-Auth-Token: u@pf#41[gYHJm<]9N[a0iWDQQ7`e9k'
      http://localhost:9400/history/customer -d '{"filters": [{"field":"src_num", "operator": "=", "value": "1456"}], "size":2}'

Response:

{
  "total":11,
  "list":[
    {"start":"2017-06-13 17:32:45","duration":"00:00:08",
    "wait_time":"00:00:06","agent_name":"Brucé Waill",
    "agent_num":"2500","queue_name":"Bl Record",
    "queue_num":"3012","status":"answered"},
    {"start":"2017-06-13 17:26:54","duration":"00:00:06",
    "wait_time":"00:00:05","agent_name":"Brucé Waill",
    "agent_num":"2500","queue_name":"Blue Ocean",
    "queue_num":"3000","status":"answered"
    }
  ]
}

Last agent for number

This api retrieves the last agent id who answered a given caller number.

Description:

URL:

/last_agent
Method:

GET
Url parameters:
callerNo:The calling number
since:The number of days to search in the history

Example Query:

curl -XGET -H "Content-Type: application/json" -H "Accept: application/json" -H 'X-Auth-Token: u@pf#41[gYHJm<]9N[a0iWDQQ7`e9k' 'http://localhost:9400/last_agent?callerNo=1002&since=100'

Response:

{"agentNumber":"2000"}