Contacts

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

Retrieve contacts [HTTP GET]

https://appapi.dlangemobile.com/xml/contacts/{api_key}

URL Parameters

• api_key (Required) - Your API application key.

Response Notes

• ID - Used to update, delete and get contact groups

Example XML Response

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

Error Codes

• 001 - API key is required.
• 002 - Invalid API key.

Retrieve contacts filtered by phone numbers [HTTP POST]

https://appapi.dlangemobile.com/xml/contacts/{api_key}/filterbynumbers

URL Parameters

• api_key (Required) - Your API application key.

Request Notes

• PhoneNumbers - list of phone numbers with country code that starts with '+'.

Example XML Request

<ArrayOfString>
  <string>+1234567890</string>
  <string>+1234567892</string>
</ArrayOfString>

Response Notes

• ID - Used to update, delete and get contact groups

Example XML Response

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

Error Codes

• 001 - API key is required.
• 002 - Invalid API key.

Add new contact [HTTP POST]

https://appapi.dlangemobile.com/xml/contacts/{api_key}

URL Parameters

• api_key (Required) - Your API application key.

Request Notes

• PhoneNumber - phone number with country code that starts with '+'.
• FirstName - Contact first name. Max number of characters is 50.
• FirstName - Contact first name. Max number of characters is 50.

Example XML Request

<Contact>
  <PhoneNumber>+1234567890</PhoneNumber>
  <FirstName>New</FirstName>
  <LastName>Contact</LastName>
</Contact>

Response Notes

• ID - Automatically-assigned ID used to update, delete and get contact groups

Example XML Response

<Contact>
  <ID>1</ID>
  <PhoneNumber>+1234567890</PhoneNumber>
  <FirstName>New</FirstName>
  <LastName>Contact</LastName>
</Contact>

Error Codes

• 001 - API key is required.
• 002 - Invalid API key.
• 110 - Provide a valid contact info. Request XML is invalid or not passed as post data.
• 104 - Provide a phone number.
• 105 - Invalid phone number format. Should contain 10-digit number.
• 106 - Invalid first name. Max number of characters allowed is 50.
• 107 - Invalid last name. Max number of characters allowed is 50.
• 108 - Phone number already exists. App does not accept duplicate phone numbers.