GetContactsBulk
Description
The GetContactsBulk method returns a subset of contacts from a specific contact list. This method is useful for users who need to retrieve and manage contacts in bulk from a specified list.
Formal Definition
https://ws.interfax.net/utils.asmx?op=GetContactsBulk
Input
| Name | Type | Comments |
|---|---|---|
| UserID | String | The name of the user authenticating to the API |
| Password | String | The password for the username |
| ListID | Integer | The ID of the contact list to retrieve |
| First | Integer | The index of the first contact to retrieve. |
| MaxCount | Integer | The maximum number of contacts to retrieve. |
Output
| Name | Type | Comments | |||
|---|---|---|---|---|---|
| GetContactsBulkResult | Structure | An object containing the results of the query, and a result code. | |||
| List | Array | Array of Contact, each with the following information: | |||
| ContactListID | Integer | The contact list ID | |||
| ContactListName | String | The name of the contact list | |||
| ContactID | Integer | The contact ID | |||
| PropertiesValues | Array | An array of contact property values. | |||
| Name | String | The name of the property | |||
| Value | String | The value of the property | |||
| ResultCode | Integer | The result of the operation: 0 for success, otherwise an error code indicating what went wrong; see the Error Codes, below | |||
Error Codes
| Value | Description |
|---|---|
| -150 | Internal System Error. An exception occurs at any point in the execution of the web service method. |
| -1003 | Authentication error: the user cannot be authenticated when either the username or the password is incorrect OR any other last error occurred when authenticating the user. |
| -2071 | User is not authorized to operate actions on the specified contact list. |
| -2072 | There is no contact list with the specified ListID that belongs to the requested UserID. |
| -2078 | Invalid parameter MaxCount. |