Contacts/Groups

EsendexContactService

The parameters for the EsendexContactService constructor include optional arguments for a security certificate:

EsendexContactService( $username, $password, $account, $isSecure = false, $certificate = '' )

To send via HTTPS, use the following arguements:

$isSecure = true
$certificate = "PATH TO CERTIFICATE FILE" ( e.g. C:\Windows\curl_ca_bundle.crt )

To send via HTTP these arguments can be ignored.

AddContact

For a successful request, results are in the format:

Result=OK ContactID=valuewhere ContactID value is the ID that Esendex assigned to the contact.

For an unsuccessful request, results are in the format:

Result=Error Message=value where Message value is a URL encoded description of the error.

GetContact

For a successful request, results are in the format:

Result=OK Messages=valuewhere Message value is an array containing contact arrays in the format: [ID] - ID that Esendex assigned to the contact
[QuickName] - reference that can be used as a recipient
[FirstName]
[LastName]
[TelephoneNumber]
[MobileNumber]
[StreetAddress1]
[StreetAddress2]
[Town]
[County]
[Postcode]
[Country] [EmailAddress]
[ContactType] - type of contact (e.g. Contact)For an unsuccessful request, results are in the format: Result=Error Message=value where Message value is a URL encoded description of the error.

AddGroup

For a successful request, results are in the format:

Result=OK GroupID=valuewhere GroupID value is the ID that Esendex assigned to the group.

For an unsuccessful request, results are in the format:

Result=Error Message=value where Message value is a URL encoded description of the error.

GetGroup

For a successful request, results are in the format:

Result=OK Messages=valuewhere Message value is an array containing group arrays in the format: [ID] - ID that Esendex assigned to the group
[Name]
[Description]
[GroupType] - type of group (e.g. Group) For an unsuccessful request, results are in the format: Result=Error Message=value where Message value is a URL encoded description of the error.

GetGroupMembers

For a successful request, results are in the format:

Result=OK Messages=valuewhere Message value is an array containing contact arrays in the format: [ID] - ID that Esendex assigned to the contact
[QuickName] - reference that can be used as a recipient
[FirstName]
[LastName]
[TelephoneNumber]
[MobileNumber]
[StreetAddress1]
[StreetAddress2]
[Town]
[County]
[Postcode]
[Country] [EmailAddress]
[ContactType] - type of contact (e.g. Contact) For an unsuccessful request, results are in the format: Result=Error Message=value where Message value is a URL encoded description of the error.

UpdateContact, DeleteContact, UpgradeGroup and DeleteGroup

For a successful request, results are in the format:

Result=OK For an unsuccessful request, results are in the format: Result=Error Message=value where Message value is a URL encoded description of the error.