RECORDING

List recordings

GET /recordfiles/extension/list

Retrieve recording list.

Request

Lists extension recordings by call ID.

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
pagination
integer
required
The pagination of paging.
pagesize
integer
optional
The pagesize of paging.
sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.
timestamp
string
optional
The earliest timestamp to filter recordings. Date-time string in ISO 8601 format (e.g. 2017-01-01T00:00:00.00Z).

Sample Request

https://example.com/api/recordfiles/extension/list?access_token=196ACE20C6F34027895F7F95402BB164&pagesize=100&pagination=1&sort_by=DEFAULT×tamp=10

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that contains call log array.

pagination
integer
required
The pagination of paging.
pagesize
integer
optional
The pagesize of paging.
sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.
page_count
integer
required
The total count of pages.
count
integer
required
Current pagesize.
recordings
array
required
Failure code in case the call failed.
Show child attributes
- call_id
  string
  required
  ID of call.
- caller
  string
  required
  Caller who started the call.
- callee
  string
  required
  Callee who answered the call.
- filename
  string
  required
  Recording file name.
- filepath
  string
  required
  Recording file path.
- start_time
  string
  required
  Start time for recording.
  Date-time string in ISO 8601 format (e.g. 2017-01-01T00:00:00.00Z)
- end_time
  string
  required
  Time on which the recording is ended.
  Date-time string in ISO 8601 format (e.g. 2017-01-01T00:00:00.00Z).
- duration
  integer
  required
  The duration that the recording lasted, in seconds.
- status
  enum
  required
  Status for this recording. "READED" or "UNREADED".

Sample Response

{
    "pagination": 1,
    "pagesize": 100,
    "sort_by": "DEFAULT",
    "page_count": 100,
    "count": 100,
    "records": [
        {
            "call_id": "101ffertwyy4",
            "caller": "caller",
            "callee": "callee",
            "filename": "example.wav",
            "filepath": "abc123.com",
            "start_time": "2017-01-01T00:00:00.00Z",
            "end_time": "2017-01-01T00:00:00.00Z",
            "duration": 100,
            "status": "READED"
        }
    ]
}

search recordings

GET /recordfiles/extension/search

Retrieve recording search.

Request

search extension recordings by call ID.

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
pagination
integer
required
The pagination of paging.
pagesize
integer
optional
The pagesize of paging.
sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.
timestamp
string
optional
The earliest timestamp to filter recordings. Date-time string in ISO 8601 format (e.g. 2017-01-01T00:00:00.00Z).
condition
string
required

Sample Request

https://example.com/api/recordfiles/extension/search?access_token=196ACE20C6F34027895F7F95402BB164&condition=100&pagesize=100&pagination=1&sort_by=DEFAULT×tamp=10

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that contains call log array.

pagination
integer
required
The pagination of paging.
pagesize
integer
optional
The pagesize of paging.
sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.
page_count
integer
required
The total count of pages.
count
integer
required
Current pagesize.
records
array
required
Failure code in case the call failed.
Show child attributes
- call_id
  string
  required
  ID of call.
- caller
  string
  required
  Caller who started the call.
- callee
  string
  required
  Callee who answered the call.
- filename
  string
  required
  Recording file name.
- filepath
  string
  required
  Recording file path.
- start_time
  string
  required
  Start time for recording.
  Date-time string in ISO 8601 format (e.g. 2017-01-01T00:00:00.00Z)
- end_time
  string
  required
  Time on which the recording is ended.
  Date-time string in ISO 8601 format (e.g. 2017-01-01T00:00:00.00Z).
- duration
  integer
  required
  The duration that the recording lasted, in seconds.
- status
  enum
  required
  Status for this recording. "READED" or "UNREADED".

Sample Response

{
    "pagination": 1,
    "pagesize": 100,
    "sort_by": "DEFAULT",
    "page_count": 100,
    "count": 100,
    "recordings": [
        {
            "call_id": "101ffertwyy4",
            "caller": "caller",
            "callee": "callee",
            "filename": "example.wav",
            "filepath": "abc123.com",
            "start_time": "2017-01-01T00:00:00.00Z",
            "end_time": "2017-01-01T00:00:00.00Z",
            "duration": 100,
            "status": "READED"
        }
    ]
}

List conference recordings

GET /recordfiles/conference/list

Retrieve conference recording list.

Request

Lists conference recordings by call ID.

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
pagination
integer
required
The pagination of paging.
pagesize
integer
optional
The pagesize of paging.
sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.
room_number
string
required
"Conference room extension number."

Sample Request

https://example.com/api/recordfiles/conference/list?access_token=196ACE20C6F34027895F7F95402BB164&pagesize=100&pagination=1&room_number=1000&sort_by=DEFAULT

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that contains call log array.

pagination
integer
required
The pagination of paging.
pagesize
integer
optional
The pagesize of paging.
sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.
page_count
integer
required
The total count of pages.
count
integer
required
Current pagesize.
records
array
required
Failure code in case the call failed.
Show child attributes
- filename
  string
  required
  Recording file name.
- filepath
  string
  required
  Recording file path.
- start_time
  string
  required
  Start time for recording.
  Date-time string in ISO 8601 format (e.g. 2017-01-01T00:00:00.00Z)
- end_time
  string
  required
  Time on which the recording is ended.
  Date-time string in ISO 8601 format (e.g. 2017-01-01T00:00:00.00Z).
- duration
  integer
  required
  The duration that the recording lasted, in seconds.
- status
  enum
  required
  Status for this recording. "READED" or "UNREADED".

Sample Response

{
    "pagination": 1,
    "pagesize": 100,
    "sort_by": "DEFAULT",
    "page_count": 100,
    "count": 100,
    "records": [
        {
            "filename": "example.wav",
            "filepath": "abc123.com",
            "start_time": "2017-01-01T00:00:00.00Z",
            "end_time": "2017-01-01T00:00:00.00Z",
            "duration": 100,
            "status": "READED"
        }
    ]
}

List voicemail recordings

GET /recordfiles/voicemail/list

Retrieve voicemail recording list.

Request

Lists voicemail recordings by call ID.

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
pagination
integer
required
The pagination of paging.
pagesize
integer
optional
The pagesize of paging.
sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.

Sample Request

https://example.com/api/recordfiles/voicemail/list?access_token=196ACE20C6F34027895F7F95402BB164&pagesize=100&pagination=1&sort_by=DEFAULT

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that contains call log array.

pagination
integer
required
The pagination of paging.
pagesize
integer
optional
The pagesize of paging.
sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.
page_count
integer
required
The total count of pages.
count
integer
required
Current pagesize.
voicemails
array
required
Failure code in case the call failed.
Show child attributes
- id
  string
  required
  ID of voicemail.
- caller
  string
  required
  Caller who started the call.
- callee
  string
  required
  Callee who answered the call.
- time
  string
  required
  Date-time string in ISO 8601 format (e.g. 2017-01-01T00:00:00.00Z).
- path
  integer
  required
  Recording file path.
- status
  enum
  required
  Status for this recording. "READED" or "UNREADED".

Sample Response

{
    "pagination": 1,
    "pagesize": 100,
    "sort_by": "DEFAULT",
    "page_count": 100,
    "count": 100,
    "records": [
        {
            "id": "111",
            "caller": "100",
            "callee": "101",
            "time": "2017-01-01T00:00:00.00Z",
            "path": "/xxx/xxx/a.wav",
            "status": "READED"
        }
    ]
}

Delete certain extension recording

POST /recordfiles/extension/destroy

Placeholders

Request

Placeholders

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
call_id
string
required
The call ID.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "call_id": "0zYQIQrQEz9TeFMf0inZfA.."
}

Response

Placeholders

Sample Response

Delete certain conference recording

POST /recordfiles/conference/destroy

Placeholders

Request

Placeholders

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
room_number
string
required
The conference room extension number.
filename
string
required
The conference recording filename.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "room_number": "0001",
    "filename": "1312312323.wav"
}

Response

Placeholders

Sample Response

Delete certain voicemail recording

POST /recordfiles/voicemail/destroy

Placeholders

Request

Placeholders

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
id
string
required
Placeholders

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "id": "0001"
}

Response

Placeholders

Sample Response

Update extension recording status

POST /recordfiles/extension/status/update

Set extension recording status

Request

Lists call logs by call ID.

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
call_id
string
required
ID of call.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "call_id": "101ffertwyy4"
}

Response

Placeholders

Sample Response

Update conference room recording status

POST /recordfiles/conference/status/update

Set conference room recording status

Request

Lists call logs by call ID.

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
room_number
string
required
Conference room extension number.
filename
string
required
Recording filename.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "room_number": 1000,
    "filename": "101ffertwyy4"
}

Response

Placeholders

Sample Response

Update voicemail recording status

POST /recordfiles/voicemail/status/update

Set voicemail recording status

Request

Lists call logs by call ID.

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
id
string
required
Placeholders

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "id": "1000"
}

Response

Placeholders

Sample Request

pagination

pagesize

sort_by

page_count

count

recordings

call_id

caller

callee

filename

filepath

start_time

end_time

duration

status

Sample Response

Sample Request

pagination

pagesize

sort_by

page_count

count

records

call_id

caller

callee

filename

filepath

start_time

end_time

duration

status

Sample Response

Sample Request

pagination

pagesize

sort_by

page_count

count

records

filename

filepath

start_time

end_time

duration

status

Sample Response

Sample Request

pagination

pagesize

sort_by

page_count

count

voicemails

id

caller

callee

time

path

status

Sample Response

Sample Request

Sample Response

Sample Request

Sample Response

Sample Request

Sample Response

Sample Request

Sample Response

Sample Request

Sample Response

Sample Request

Sample Response

`pagination`

`pagesize`

`sort_by`

`page_count`

`count`

`recordings`

`call_id`

`caller`

`callee`

`filename`

`filepath`

`start_time`

`end_time`

`duration`

`status`

`pagination`

`pagesize`

`sort_by`

`page_count`

`count`

`records`

`call_id`

`caller`

`callee`

`filename`

`filepath`

`start_time`

`end_time`

`duration`

`status`

`pagination`

`pagesize`

`sort_by`

`page_count`

`count`

`records`

`filename`

`filepath`

`start_time`

`end_time`

`duration`

`status`

`pagination`

`pagesize`

`sort_by`

`page_count`

`count`

`voicemails`

`id`

`caller`

`callee`

`time`

`path`

`status`