JSON API » bulk » bulk/destinations/create
Adds new destinations to a bulk campaign. Any matching existing destinations are replaced.
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 | |
| campaign | Integer | ID of campaign. | Yes | |
| dnumbers | String | Destinations. If multiple, separate with commas. | Yes | |
| status | String | The initial status of the destinations. "cancelled", "failed", "pending", or "success". | No | "pending" |
| validation | Integer | 1 to validate input then return, 0 for full action. | No | 0 |
Responses
| Code | Description |
|---|---|
| 200 | Success. |
| 201 | Input passed validation. Only returned if validation=1. |
| 400 | Invalid input parameters specified. Check the key and message fields for more details. |
| 401 | The authentication details provided are invalid. |
| 402 | Your role does not allow this. |
| 404 | The campaign does not exist, or you do not have permission to update it. |
Data returned
The number of destinations added or replaced.
Example: With required parameters
https://www.015pbx.net/local/api/json/bulk/destinations/create/?auth_username=user;auth_password=password;campaign=123;dnumbers=2125551234{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "count":"1" } }
Example: With two destinations
https://www.015pbx.net/local/api/json/bulk/destinations/create/?auth_username=user;auth_password=password;campaign=123;dnumbers=2125551234,2125551235{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "count":"2" } }