JSON API » bulk » bulk/destinations/get
Gets the fields of a bulk campaign destination.
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 containing destination. | Yes | |
dnumber | String | Destination to get. | Yes |
Responses
Code | Description |
---|---|
200 | Success. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The campaign or destination does not exist, or you do not have permission to view it. |
Data returned
Fields of destination.
Example: With required parameters
http://enswitch.example.com/api/json/bulk/destinations/get/?auth_username=user;auth_password=password;campaign=123;dnumber=2125551234{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "dtype":"", "dnumber":"2125551234", ... } }
Change history
Version | Changes |
---|---|
3.13 | Function added. |