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

200
Successful operation
404
User not found
400
Invalid conference room's record ID supplied

Sample Response

                      
                      
                    

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
  • records

    array

    Show child attributes
  • count

    integer

Sample Response

                      
{
    "count": 100
}
                      
                    

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

200
Successful operation
404
User not found
400
Invalid voicemail ID supplied

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

200
Successful operation
404
User not found
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

200
Successful operation
404
User not found
400
Invalid voicemail 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

200
Successful operation
404
User not found
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
  • caller

    string

    Caller who started the call.
  • 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

  • id

    integer

    The unique id.

    format : int64

  • callee

    string

    Callee who answered 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

  • duration

    integer

    The talk duration of the call record, in seconds.
  • filepath

    string

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

    string

    status of the call record.

    enum : ['readed', 'unreaded']

  • filename

    string

    filename of call record.

Sample Response

                      
{
    "id": 111
}
                      
                    

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
  • id

    integer

    The unique id.

    format : int64

  • targets

    array

    Show child attributes
  • count

    integer

    count. example: 1

Sample Response

                      
{
    "id": 111
}
                      
                    

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
  • sort_by

    string

  • records

    array

    Show child attributes
  • pagesize

    integer

  • pagination

    integer

  • count

    integer

Sample Response

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

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

200
Successful operation
404
User not found
400
Invalid call record 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
  • sort_by

    string

  • records

    array

    Show child attributes
  • pagesize

    integer

  • pagination

    integer

  • count

    integer

Sample Response

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