Login

  • Sms
  • GET AddressBook

List of headings

This method allows you to get a list of the headings linked to your account or the details of a specific address book.

Resource

Production environment:

  • https://software.messaggisms.com/api/addressBook
  • https://software.messaggisms.com/api/addressBook/"addressBook_name"

Testing environment

  • https://software.test.messaggisms.com/api/addressBook
  • https://software.test.messaggisms.com/api/addressBook/"addressBook_name"

Parameters

Request Example

Response

Response Format

If successful, the response header HTTP status code will be 200 OK and the request will be answered.

If you try to get a request without authorization, you will receive an error 401 Unauthorized.

Additionally you should also handle the 400 Bad request status. For more info on HTTP status handling see dedicated section in Integration best practices page.

Request Response

Parameter Type Description
success boolean True or false.
code int If the API call is successful, it will be 200, otherwise 4xx.
data DataResponseDetails Present only if the API call goes to good end, it will contain the answer data.
error_code string Present only if the API call fails, it contains an error code in string format.
message string Present only if the API call does not go to its end, it contains a message that can be shown by the user.

Data Response Details

If the request is for all the address book:

Parameter Type Description
name string The name of the address book.
note string Any notes entered in the address book.
last_send_data date (Y-m-d) The date of the last sending made through that address book.

Data Response Details

If the request is for a specific address book:

Parameter Type Description
name string The name of the address book.
note string Any notes entered in the address book.
last_send_data date (Y-m-d) The date of the last sending made through that address book.
contacts_number int The number of contacts in the address book.
contacts ContactsResponseDetails Array containing the contact list.

Contacts Response Details

Parameter Type Description
email string The contact's email address.
name string The name of the contact.
last_name string The last name of the contact.
phone string The contact's telephone number.
birthday_date date (Y-m-d) The date of birth of the contact.
sex enum (M|F) The sex of the contact.
company_name string The company name of the contact.
address string The full address of the contact.
zip_code string The ZIP code of the contact.
city string The city of contact.
region string The contact region.
custom_field1 string The custom field 1 of the contact.
custom_field2 string The custom field 2 of the contact.
custom_field3 string The custom field 3 of the contact.
custom_field4 string The custom field 4 of the contact.
last_reading_date datetime (Y-m-d H:i:s) The last date the contact read a campaign email.
last_iteration_date datetime (Y-m-d H:i:s) The last date on which the contact interacted with a campaign (read or click).
last_click_date datetime (Y-m-d H:i:s) The last date the contact clicked on a campaign email link.
addressbooks array List of address book where the contact is present.

Additional examples

Request of a specific address book:

Response