CALLRECORD

update voicemail status to readed

POST /voicemail/status/update

update voicemail status to readed

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

id

integer

required

The unique id.

format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/recordfiles/voicemail/status/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 111
}'

Responses

`404`

User not found

`200`

Successful operation

`400`

Invalid voicemail ID supplied

Sample Response

Retrieve a collection of voicemail entry.

GET /voicemail/list

Retrieve a collection of voicemail entry.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64
pagination

integer

required

The pagination of paging.

format : int32
pagesize

integer

required

The size of paging.
sort_by

string

optional

Values include "DEFAULT" and "Optional". Default value will be used when user does not specify value for this field.

enum : ['DEFAULT', 'OPTIONAL']

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/recordfiles/voicemail/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

`200`

Successful operation

application/json

pagesize

integer
count

integer
records

array

Show child attributes
- status
  
  string
  
  status of the answered.
  
  enum : ['readed', 'unreaded']
- path
  
  string
  
  file download id of voicemail. use http://127.0.0.1:9333/$path to download file.
- callee
  
  string
  
  Callee who answered the call.
- time
  
  string
  
  Time of voicemail created. Date-time string in ISO 8601 format (e.g. 2017-01-01 00:00:00).
  
  format : date-time
- caller
  
  string
  
  Caller who started the call.
- id
  
  integer
  
  The unique id.
  
  format : int64
pagination

integer
sort_by

string

Sample Response

                      
{
    "pagesize": 10,
    "count": 100,
    "pagination": 8,
    "sort_by": "DEFAULT"
}

search a collection of call record entry.

GET /extension/search

search a collection of call record entry.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64
pagination

integer

required

The pagination of paging.

format : int32
pagesize

integer

required

The size of paging.
sort_by

string

optional

Values include "DEFAULT" and "Optional". Default value will be used when user does not specify value for this field.

enum : ['DEFAULT', 'OPTIONAL']
counts

integer

optional

counts.
start_time

string

optional

start time

format : date-time
end_time

string

optional

end time

format : date-time
condition

string

optional

search condition.

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/recordfiles/extension/search \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

`200`

Successful operation

application/json

pagesize

integer
count

integer
pagination

integer
call_hitorys

array

Show child attributes
- filename
  
  string
  
  filename of call record.
- end_time
  
  string
  
  Time on which the call is ended. Date-time string in ISO 8601 format (e.g. 2017-01-01 00:00:00).
  
  format : date-time
- status
  
  string
  
  status of the call record.
  
  enum : ['readed', 'unreaded']
- callee
  
  string
  
  Callee who answered the call.
- filepath
  
  string
  
  file download id of call record. use http://127.0.0.1:9333/$filepath to download file.
- duration
  
  integer
  
  The talk duration of the call record, in seconds.
- answer_time
  
  string
  
  Time on which the call is answered. Date-time string in ISO 8601 format (e.g. 2017-01-01 00:00:00).
  
  format : date-time
- caller
  
  string
  
  Caller who started the call.
- id
  
  integer
  
  The unique id.
  
  format : int64
sort_by

string

Sample Response

                      
{
    "pagesize": 10,
    "count": 100,
    "pagination": 8,
    "sort_by": "DEFAULT"
}

delete call record

POST /extension/destroy

delete call record

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

id

integer

required

The unique id.

format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/recordfiles/extension/destroy \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 111
}'

Responses

`404`

User not found

`200`

Successful operation

`400`

Invalid call record ID supplied

Sample Response

delete voicemail

POST /voicemail/destroy

delete voicemail

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

id

integer

required

The unique id.

format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/recordfiles/voicemail/destroy \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 111
}'

Responses

`404`

User not found

`200`

Successful operation

`400`

Invalid voicemail ID supplied

Sample Response

Retrieve call target of call record entry.

GET /extension/show

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64
id

integer

required

The unique id.

format : int64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/recordfiles/extension/show \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

`200`

Successful operation

application/json

count

integer

count. example: 1
targets

array

Show child attributes
- end_time
  
  string
  
  Time on which the call is ended. Date-time string in ISO 8601 format (e.g. 2017-01-01 00:00:00).
  
  format : date-time
- reroute_reason
  
  string
  
  reroute reason of the call taget.
  
  enum : ['NONE', 'UNATTENDED_TRANSFER', 'OVERLOW']
- direction
  
  string
  
  direction of the call taget.
  
  enum : ['UNKNOWN', 'INBOUND_CALL', 'OUTBOUND_CALL', 'EXTENSION_CALL', 'INBOUND_OUTBOUND_CALL']
- end_reason
  
  string
  
  end reason of the call taget.
  
  enum : ['NONE', 'DISCONNECT', 'REPLACED', 'REFERRED', 'REDIRECTED']
- ring_duration
  
  integer
  
  The ring duration of the call taget, in seconds.
- ringing_time
  
  string
  
  Time on which the call is ringing. Date-time string in ISO 8601 format (e.g. 2017-01-01 00:00:00).
  
  format : date-time
- destination
  
  string
  
  Extension number of callee.
- answer_time
  
  string
  
  Time on which the call is answered. Date-time string in ISO 8601 format (e.g. 2017-01-01 00:00:00).
  
  format : date-time
- target_cost
  
  number
  
  cost of the call taget.
  
  format : double
- status
  
  string
  
  status of the call taget.
  
  enum : ['NONE', 'ANSWERED', 'NOANSWER', 'FAIL']
- rating
  
  object
  
  Show child attributes
  - type
    
    string
    
    type of the call taget rating.
    
    enum : ['NONE', 'INCOMING', 'OUTGOING']
  - interval1
    
    integer
    
    interval1 of the call taget rating.
  - grace_period
    
    integer
    
    grace period of the call taget rating.
  - pricen
    
    number
    
    pricen of the call taget rating.
    
    format : double
  - postcall_surcharge
    
    number
    
    postcall surcharge of the call taget rating.
    
    format : double
  - price1
    
    number
    
    price1 of the call taget rating.
    
    format : double
  - free_seconds
    
    integer
    
    free seconds of the call taget rating.
  - connect_fee
    
    number
    
    connect fee of the call taget rating.
    
    format : double
  - call_prefix
    
    string
    
    call prefix of the call taget rating.
  - intervaln
    
    integer
    
    intervaln of the call taget rating.
- add_time
  
  string
  
  Time on which the callee is called. Date-time string in ISO 8601 format (e.g. 2017-01-01 00:00:00).
  
  format : date-time
- fail_code
  
  integer
  
  Failure code in case the call failed.
- talk_duration
  
  integer
  
  The talk duration of the call taget, in seconds.
id

integer

The unique id.

format : int64

Sample Response

update call record status to readed

POST /extension/status/update

update call record status to readed

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

id

integer

required

The unique id.

format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/recordfiles/extension/status/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 111
}'

Responses

`404`

User not found

`200`

Successful operation

`400`

Invalid call record ID supplied

Sample Response

update conference room's record status to readed

POST /conference/status/update

update conference room's record status to readed

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

id

integer

required

The unique id.

format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/recordfiles/conference/status/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 111
}'

Responses

`404`

User not found

`200`

Successful operation

`400`

Invalid conference room's record ID supplied

Sample Response

Retrieve a collection of call record entry.

GET /extension/list

Retrieve a collection of call record entry.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64
pagination

integer

required

The pagination of paging.

format : int32
pagesize

integer

required

The size of paging.
sort_by

string

optional

Values include "DEFAULT" and "Optional". Default value will be used when user does not specify value for this field.

enum : ['DEFAULT', 'OPTIONAL']
counts

integer

optional

counts.
start_time

string

optional

start time

format : date-time
end_time

string

optional

end time

format : date-time
extension

string

optional

search condition.

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/recordfiles/extension/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

`200`

Successful operation

application/json

pagesize

integer
count

integer
records

array

Show child attributes
- filename
  
  string
  
  filename of call record.
- end_time
  
  string
  
  Time on which the call is ended. Date-time string in ISO 8601 format (e.g. 2017-01-01 00:00:00).
  
  format : date-time
- status
  
  string
  
  status of the call record.
  
  enum : ['readed', 'unreaded']
- callee
  
  string
  
  Callee who answered the call.
- filepath
  
  string
  
  file download id of call record. use http://127.0.0.1:9333/$filepath to download file.
- duration
  
  integer
  
  The talk duration of the call record, in seconds.
- answer_time
  
  string
  
  Time on which the call is answered. Date-time string in ISO 8601 format (e.g. 2017-01-01 00:00:00).
  
  format : date-time
- caller
  
  string
  
  Caller who started the call.
- id
  
  integer
  
  The unique id.
  
  format : int64
pagination

integer
sort_by

string

Sample Response

                      
{
    "pagesize": 10,
    "count": 100,
    "pagination": 8,
    "sort_by": "DEFAULT"
}

Retrieve a collection of conference room's record entry.

GET /conference/list

Retrieve a collection of conference room's record entry.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64
id

integer

required

The unique id.

format : int64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/recordfiles/conference/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

`200`

Successful operation

application/json

count

integer
records

array

Show child attributes
- filename
  
  string
  
  filename of call record.
- end_time
  
  string
  
  Time on which the call is ended. Date-time string in ISO 8601 format (e.g. 2017-01-01 00:00:00).
  
  format : date-time
- status
  
  string
  
  status of the call record.
  
  enum : ['readed', 'unreaded']
- filepath
  
  string
  
  file download id of call record. use http://127.0.0.1:9333/$filepath to download file.
- duration
  
  integer
  
  The talk duration of the call record, in seconds.
- answer_time
  
  string
  
  Time on which the call is answered. Date-time string in ISO 8601 format (e.g. 2017-01-01 00:00:00).
  
  format : date-time
- id
  
  integer
  
  The unique id.
  
  format : int64

Sample Response

                      
{
    "count": 100
}

delete conference room's record

POST /conference/destroy

delete voicemail

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

id

integer

required

The unique id.

format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/recordfiles/conference/destroy \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 111
}'

Responses

`404`

User not found

`200`

Successful operation

`400`

Invalid conference room's record ID supplied

Sample Response

Retrieve call record entry by session id.

GET /extension/session/show

Retrieve call record entry by session id.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64
id

integer

required

The unique id.

format : int64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/recordfiles/extension/session/show \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

`200`

Successful operation

application/json

filename

string

filename of call record.
end_time

string

Time on which the call is ended. Date-time string in ISO 8601 format (e.g. 2017-01-01 00:00:00).

format : date-time
status

string

status of the call record.

enum : ['readed', 'unreaded']
callee

string

Callee who answered the call.
filepath

string

file download path of call record. use http://127.0.0.1:9333/$filepath to download file.
duration

integer

The talk duration of the call record, in seconds.
id

integer

The unique id.

format : int64
caller

string

Caller who started the call.
answer_time

string

Time on which the call is answered. Date-time string in ISO 8601 format (e.g. 2017-01-01 00:00:00).

format : date-time

Sample Response

Sample Request

404

200

400

Sample Response

Sample Request

200

application/json

pagesize

count

records

status

path

callee

time

caller

id

pagination

sort_by

Sample Response

Sample Request

200

application/json

pagesize

count

pagination

call_hitorys

filename

end_time

status

callee

filepath

duration

answer_time

caller

id

sort_by

Sample Response

Sample Request

404

200

400

Sample Response

Sample Request

404

200

400

Sample Response

Sample Request

200

application/json

count

targets

end_time

reroute_reason

direction

end_reason

ring_duration

ringing_time

destination

answer_time

target_cost

status

rating

type

interval1

grace_period

pricen

postcall_surcharge

price1

free_seconds

connect_fee

call_prefix

intervaln

add_time

fail_code

talk_duration

id

Sample Response

Sample Request

`404`

`200`

`400`

`200`

`pagesize`

`count`

`records`

`status`

`path`

`callee`

`time`

`caller`

`id`

`pagination`

`sort_by`

`200`

`pagesize`

`count`

`pagination`

`call_hitorys`

`filename`

`end_time`

`status`

`callee`

`filepath`

`duration`

`answer_time`

`caller`

`id`

`sort_by`

`404`

`200`

`400`

`404`

`200`

`400`

`200`

`count`

`targets`

`end_time`

`reroute_reason`

`direction`

`end_reason`

`ring_duration`

`ringing_time`

`destination`

`answer_time`

`target_cost`

`status`

`rating`

`type`

`interval1`

`grace_period`

`pricen`

`postcall_surcharge`

`price1`

`free_seconds`

`connect_fee`

`call_prefix`

`intervaln`

`add_time`

`fail_code`

`talk_duration`

`id`

`404`

`200`

`400`

`404`

`200`

`400`