logo   HOME

Contacts

This page lists the optional parameters, request data and reponse in xml

Retrieve opted out contacts [HTTP GET]

https://appapi.dlangemobile.com/xml/contacts/{api_key}/optedout?start_date={startdate}&end_date={enddate}

URL Parameters

  • api_key (Required) - Your API application key.

Query string Parameters

  • start_date (Required) - Start Date of the opted out contacts you want to retrieve. Must be in yyyy-mm-dd format.
  • end_date (Required) - End Date of the opted out contacts you want to retrieve. Must be in yyyy-mm-dd format.

Example XML Response

<Contacts>
  <Contact>
    <ID>1</ID>
    <PhoneNumber>+1234567890</PhoneNumber>
    <FirstName>Test</FirstName>
    <LastName>Contact 1</LastName>
    <OptedOut>true</OptedOut>
  </Contact>
  <Contact>
    <ID>2</ID>
    <PhoneNumber>+1234567891</PhoneNumber>
    <FirstName>Test</FirstName>
    <LastName>Contact 2</LastName>
    <OptedOut>true</OptedOut>
  </Contact>
</Contacts>

Error Codes

  • 001 - API key is required.
  • 002 - Invalid API key.
  • 115 - Define a valid Start Date.
  • 116 - Define a valid End Date.