Get your autodialer subscriptions
Fetch active autodialer subscription and their subscription plans information, filtered by given parameters. Returns data with pagination. Each Autodialer subscription contains data about its billing.
Query Parameters
Accepts a list of frequency values to filter by. If the list is empty, this filter will be ignored.
Accepts a list of autodialer subscriptions unique ids to filter by. If the list is empty, this filter will be ignored.
Optional parameter. Allows to filter subscriptions by activation. Only subscriptions with activation value greater than the given will be returned.
0 <= valueOptional parameter. Allows to filter subscriptions by activation. Only subscriptions with activation value less than the given will be returned.
0 <= valuePagination parameters. Accepts page number. Pagination starts on page=1. If parameter is not provided, the default value of 1 will be set.
Pagination parameter. Accepts the size of page for pagination. Minimal page size is 1. If parameter is not provided, the default value of 10 will be set.
Time period filter, determines the end of the period. Accepts string with time either as UNIX timestamp, or in format 2006-01-02T15:04:05Z07:00.
Time period filter, determines the start of the period. Accepts string with time either as UNIX timestamp, or in format 2006-01-02T15:04:05Z07:00.
Accepts a list of autodialer plans unique ids to filter by. Only subscription with these plans will be returned. If the list is empty, this filter will be ignored. Plan IDs can be obtained from GET /api/v1/autodialer/plans.
Optional parameter. Allows to filter subscriptions by price_per_user. Only subscriptions with price_per_user value greater than the given will be returned.
0 <= valueOptional parameter. Allows to filter subscriptions by price_per_user. Only subscriptions with price_per_user value less than the given will be returned.
0 <= valueOptional parameter that allows to search Autodialers by name and comment, subscription plan's title and/or description values. The search operation is partial.
Ordering parameter. Defines by which field the data will be sorted. If parameter is not provided, will be used entity's default ordering. To use entity's default sorting, pass _default as value.
"_default" | "activated_at" | "next_payment_at" | "title" | "description" | "name" | "url" | "comment" | "subscription_status" | "activation" | "base_monthly" | "price_per_user" | "frequency" | "status"Ordering parameter. Defines the order of sorting (asc or desc). If parameter is not provided, will be used entity's default ordering.
"asc" | "desc"Accepts a list of autodialer statuses to filter by. If the list is empty, this filter will be ignored.
Optional parameter. Allows to filter subscriptions by base_monthly. Only subscriptions with base_monthly value greater than the given will be returned.
0 <= valueOptional parameter. Allows to filter subscriptions by base_monthly. Only subscriptions with base_monthly value less than the given will be returned.
0 <= valueHeader Parameters
Your API token
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://dev-refactor-api-e.voipenv.uk/api/v1/autodialer/subscriptions" \ -H "Authorization: string"{
"data": [
{
"activated_at": "string",
"activation": 0,
"agents_count": 0,
"base_monthly": 0,
"comment": "string",
"frequency": "monthly",
"id": 0,
"name": "string",
"next_payment_at": "string",
"plan": {
"activation": 0,
"description": "string",
"frequency": "monthly",
"id": 0,
"monthly": 0,
"price_per_user": 0,
"title": "string"
},
"price_per_user": 0,
"status": "configuring",
"subscription_status": "disabled",
"url": "string"
}
],
"page": 0,
"page_size": 0,
"total": 0,
"total_pages": 0
}{
"code": 0,
"error_details": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"message": "string",
"request_id": "string",
"status": "error"
}{
"code": 0,
"error_details": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"message": "string",
"request_id": "string",
"status": "error"
}{
"code": 0,
"error_details": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"message": "string",
"request_id": "string",
"status": "error"
}
