Retrieves a list of outbound calling campaigns

Method	`get.auto_call_campaigns`
Description	Retrieves a list of outbound calling campaigns
Available to	Agent, Client

Request parameters

Name	Type	Required	Description
`access_token`	string	yes	Authentication session key
`user_id`	number	no	Unique user identifier of the agent client on behalf of which the request is made Is required for the agent To obtain a list of client users, use the method "get.customer_users"
`limit`	number	no	Number of records returned. See section "Paging"
`offset`	number	no	Shift determines from which record number to return `"limit"` records. Default is "0". See section "Paging"
`filter`	object	no	See section "Filtering criteria"
`fields`	array	no	See section "View of returned data"
`sort`	array	no	See section "Sorting data"

Response parameters

Name	Type	Valid values	Filtering	Sorting	Description
`id`	number		yes		Unique outbound calling campaign identifier
`name`	string		yes	yes	Campaign name
`add_time`	iso8601	YYYY-MM-DD hh:mm:ss			Campaign creation date
`begin_date`	iso8601	YYYY-MM-DD hh:mm:ss			Date and time when the outbound calling campaign started
`end_date`	iso8601	YYYY-MM-DD hh:mm:ss			Date and time when the outbound calling campaign ended
`status`	enum	`draft` - Draft `planned` - Scheduled `in_process` - In progress `paused` - Suspended `completed` - Completed `cancelled` - Canceled	yes		Campaign status
`phone_numbers`	array				List of subscriber numbers
`phone_number`	string		yes		Subscriber number
`status`	enum	`successfully_processed` - Successful `unsuccessfully_processed` - Unsuccessful `not_processed` - Not processed `processed_outside_campaign` - Processed outside the campaign `deleted` - Deleted	yes		Number status in the campaign

JSON request structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.auto_call_campaigns",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON response structure

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "metadata": {

    },
    "data": [
      {
        "id": "number",
        "name": "string",
        "add_time": "iso8601",
        "begin_date": "iso8601",
        "end_date": "iso8601",
        "status": "enum",
        "phone_numbers": [
          {
            "phone_number": "string",
            "status": "enum"
          }
        ]
      }
    ]
  }
}

List of returned errors

See the section "List of errors for methods with the verb get"