Scheduled Requests

List Scheduled Requests for extension

Returns list of scheduled requests for extension

get/v4/accounts/{voip_id}/extensions/{extension_id}/scheduled-requests

Request

  • Base URL: https://api.phone.com
  • URL: https://api.phone.com/v4/accounts/{voip_id}/extensions/{extension_id}/scheduled-requests
  • Auth: HTTP bearer

Path parameters

voip_idinteger required
extension_idinteger required

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The number of items to return

sort[id]'asc' | 'desc'

Sort response

include_subaccountsinteger

Send "1" if you want to add subaccounts data into output

filters[scheduled_at]string

Scheduled time filter. Expected value is UNIX timestamp with operator like "gt" (greater than), "gte" (greater than or equals), "lt" (lesser than), "lte" (lesser than or equals). Example: "gt:1597778180".

filters[processed_at]string

Processed time filter. Expected value is UNIX timestamp with operator like "gt" (greater than), "gte" (greater than or equals), "lt" (lesser than), "lte" (lesser than or equals). Example: "gt:1597778180".

filters[processed_status]string

Execution status - "failed" or "success"

filters[is_processed]string

Processing status filter (1 for processed requests, 0 for scheduled)

filters[tag]string

Technical identifier

mode'brief' | 'full'

Defines mode of the data output (brief or full)

Response

OK

filtersobject
sortobject
totalinteger
limitinteger
offsetinteger
itemsobject[]

Changes

No operation changes recorded.