Contact
This web service provides methods that allow you to create, manage and report upon address book contacts.
The following operations are supported. For a formal definition, please review the Service Description.
-
Add
Adds a new contact to an address book.Parameter
Notes
Username: Password: FirstName: Provide a first name for you new contact. LastName: Provide a second name for you new contact. MobilePhone: Provide a mobile device number for you new contact. EmailAddress: Provide an email address for you new contact. GroupName: Provide a group name from your address book to put your new contact in. If you do not want to put the contact in a group set this parameter to null. ResultText: E.g. 3 entries added to address book for your.address@your.company. 3 entries added to group MyExistingGroup. Code: -
AddContact
Adds a new contact to an address book and returns the person number assigned to the new contact.Parameter
Notes
Username: Password: FirstName: Provide a first name for you new contact. LastName: Provide a second name for you new contact. MobilePhone: Provide a mobile device number for you new contact. EmailAddress: Provide an email address for you new contact. GroupName: Provide a group name from your address book to put your new contact in. If you do not want to put the contact in a group set this parameter to null. Duplicate: Determines if a contact can be added if their is already one present. ViewDetailResult: Determines if the person number is returned to the user ContactID: Returns the contact details stored in the address book in CSV format ResultText: E.g. 3 entries added to address book for your.address@your.company. 3 entries added to group MyExistingGroup. Code: -
Delete
Deletes contacts from an address book.Parameter
Notes
Username: Password: PersonNumber: Provide a semi-colon delimited string of the valid person numbers to delete. The List or ListSelected methods of this web service can be used to determine the person numbers of all the contacts for this account. ResultText: E.g. 3 entries removed from address book for your.address@your.company. Code: -
List
Lists all contact's details.Parameter
Notes
Username: Password: ReportCSV: Provide a string data type output parameter. This will be populated with a CSV standard format string of records containing information about an account's contacts. ResultText: E.g. Address Book for your.address@your.company was successfully retreived. Code: -
ListSelected
Lists a selected contact's details.Parameter
Notes
Username: Password: EmailAddress: Provide a semi-colon delimited string of email addresses from you address book. Only provide the email addresses for contacts you need to know information about. ReportCSV: Provide a string data type output parameter. This will be populated with a CSV standard format string of records containing information about the contacts specified in the EmailAddress parameter. ResultText: E.g. Selected entries from address Book for your.address@your.company. Code: -
ListStopLog
Lists all contact's details that appear in the 2sms's Stop Log table.Parameter
Notes
Username: Password: ReportCSV: Provide a string data type output parameter. This will be populated with a CSV standard format string of records containing information about an account's contacts. ResultText: E.g. Address Book for your.address@your.company was successfully retreived. Code: -
ListStopLogSelected
Returns whether the phone numbers provided appear in the 2sms's Stop Log table.Parameter
Notes
Username: Password: PhoneNumbers: Provide a semi-colon delimited string of phone numbers from your address book. Only provide the phone numbers for contacts you need to know information about. ReportCSV: Provide a string data type output parameter. This will be populated with a CSV standard format string of records containing information about the contacts specified in the EmailAddress parameter. ResultText: E.g. Selected entries from address Book for your.address@your.company. Code: -
Modify
Modify a contact in an address book.Parameter
Notes
Username: Password: PersonNumber: Provide a valid person numbers to modify. The List or ListSelected methods of this web service can be used to determine the person numbers of all the contacts for this account. FirstName: Modified first name for you new contact. If you do not wish to modify this parameter set it to null. LastName: Modified second name for you new contact. If you do not wish to modify this parameter set it to null. MobilePhone: Modified mobile device number for you new contact. If you do not wish to modify this parameter set it to null. EmailAddress: Modified email address for you new contact. If you do not wish to modify this parameter set it to null. ResultText: E.g. Address book entry succesfully modified. Code: