Active Call



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/active-calls

Summary


Resources Methods
https://localhost:8443/api/rest/active-calls

GET Retrieves a list of active calls filtered by optional query parameters.

POST  Creates a subscription to call server active call notifications.

https://localhost:8443/api/rest/active-calls/{active-call-identifier}

DELETE  Terminate active call.

https://localhost:8443/api/rest/active-calls/statistics

GET  Retrieve active call statistics.

https://localhost:8443/api/rest/active-calls/vmr-counts

GET  Retrieve vmr counts [tags: DMA] .

Resources


https://localhost:8443/api/rest/active-calls


Methods

GET

Retrieves a list of active calls filtered by optional query parameters. [tags: DMA]

Request

Query Parameters

Name Type Description
dial-string xs:string
Retrieve active calls associated with this dial string.
cluster xs:string
Retrieve active calls associated with this cluster.
territory xs:string
Retrieve active calls associated with this territory name.
originator xs:string
Retrieve active calls originated from this IP address,
alias or device name.
destination xs:string
Retrieve active calls terminated to this IP address,
alias or device name.
protocol xs:string
Retrieve active calls associated with this protocol.
site xs:string
Retrieve active calls associated with this site.
status xs:string
Retrieve active calls for which associated device has this registration status.
service-level xs:string
Retrieve active calls having this service level.
from-bit-rate xs:string
Retrieve active calls having this as minimum bit rate.
to-bit-rate xs:string
Retrieve active calls having this as maximum bit rate.
sort-key xs:string
Sort the result based on this key.

Sort key can have following values.
'start-time': Sort the result by start time.
'originator': Sort the result by originator address.
'destination': Sort the result by destination address.
'dial-string': Sort the result by dial string.
'bit-rate': Sort the result by bit rate.
'service-class': Sort the result by service class.
sort-order xs:string
Sort the result based on this direction.

Sort order can have following values:
'ascending': Sort the result in ascending order.
'descending': Sort the result in descending order.

To specify default sort order, this parameter should be null.
limit xs:int
Limit the number of users returned to this number, even if more results match the query.
Note 1: The valid integer range is 1 to 500; values between 501 and 2147483647 will result in the default limit of 500 being used.
Note 2: If the limit value is less than or equal to 0, the default of 500 will be used.
Note 3: If the limit value is greater than 2147483647, the system will respond with "404 Not Found".
This is a framework response that is due to a numeric value that exceeds a integer type.
page xs:int
When limiting the results, this specifies which page/subset of data to view.
Note 1: The valid integer range is 1 to 2147483647.
Note 2: If the page value is less than or equal to 0, the default of 1 will be used.
Note 3: If the page value is greater than 2147483647, the system will respond with "404 Not Found".
This is a framework response that is due to a numeric value that exceeds a integer type.

Response

Status Representation Description
200 application/vnd.plcm.plcm-active-call-list+xml
application/vnd.plcm.plcm-active-call-list+json
application/vnd.plcm.plcm-active-call-list-v2+xml
application/vnd.plcm.plcm-active-call-list-v2+json
application/vnd.plcm.plcm-active-call-list-v3+xml
application/vnd.plcm.plcm-active-call-list-v3+json
Active call list retrieved successfully.
304
Active call list information has not changed since the last search.

Note: The API client must provide the "plcm-active-call-list" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-active-call-list" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator, provisioner
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid value provided for search filter.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid value provided for sort key.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid value provided for sort order.

POST


Creates a subscription to call server active call notifications. Once subscribed,
clients will receive asynchronous notifications for active call state changes.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-active-call-subscription+xml
application/vnd.plcm.plcm-active-call-subscription+json
application/vnd.plcm.plcm-active-call-subscription-v2+xml
application/vnd.plcm.plcm-active-call-subscription-v2+json

Response

Status Representation Description
201 Subscription created successfully
400 text/plain
Bad request
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

TTL Out of Range. Correct values are "0" (magic number which sets end time to the max, 26 hours), or
any integer between 1 and 93600 (26 hours) in seconds.

https://localhost:8443/api/rest/active-calls/{active-call-identifier}


Template Parameters

Name Type Description
active-call-identifier xs:string Unique identifier of the call.

Methods

DELETE


Terminate active call.
[tags: DMA]

Response

Status Representation Description
204 Active call terminated successfully.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator, provisioner
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such call exists on the call server.

https://localhost:8443/api/rest/active-calls/statistics


Methods

GET


Retrieve active call statistics.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-active-call-statistics+xml
application/vnd.plcm.plcm-active-call-statistics+json
Active call statistics retrieved successfully.
304
Active call statistics information has not changed since the last search.

Note: The API client must provide the "plcm-active-call-statistics" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-active-call-statistics" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator, auditor, provisioner

https://localhost:8443/api/rest/active-calls/vmr-counts


Methods

GET


Retrieve vmr counts
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-vmr-counts+xml
application/vnd.plcm.plcm-vmr-counts+json
VmrCounts records successfully retrieved.
304
VmrCounts records have not changed since the last get.

Note: The API client must provide the "plcm-vmr-counts" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-vmr-counts" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator, auditor, provisioner