JSON API » bulk » bulk/campaigns/list
Gets the fields of all bulk campaigns visible to the user in the given customer.
Input parameters
Requires authentication and the user role privilege.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| auth_username | String | Authentication username. | Yes | |
| auth_password | String | Authentication password. | Yes | |
| customer | Integer | ID of customer to get bulk campigns for. | No | Customer of authentication user. |
Responses
| Code | Description |
|---|---|
| 200 | Success. |
| 400 | Invalid customer specified. |
| 401 | The authentication details provided are invalid. |
| 402 | Your role does not allow this. |
Data returned
An array of fields, corresponding to the rows of the bulk_campaigns table in the database.
Example: With required parameters
https://www.015pbx.net/local/api/json/bulk/campaigns/list/?auth_username=user;auth_password=password{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":"1", "name":"example1", ... }, { "id":"2", "name":"example2", ... } ] }