Settings - API - Phone number search

Contact Look-Up by Phone Number

1. Endpoint and Method

2. Authentication

Authentication is handled via the Authorization header using Basic Auth.

Important: You must use HTTPS for all connections

3. Mandatory Fields

A successful submission requires the following:

• Authentication: Valid cid (API Key) and password via Basic Auth.

• Mandatory Field: PhoneNumber must be supplied.

• Phone Data: After cleaning, PhoneNumber must contain at least one digit.

4. cURL Example

This example demonstrates checking for an existing record associated with a phone number.

# Replace 'YOUR_API_KEY' and 'YOUR_PASSWORD' with your actual credentials
curl -X POST 'https://api.autovusolutions.com/api/ContactFromPhone.aspx' \
     -u 'YOUR_API_KEY:YOUR_PASSWORD' \
     --data-urlencode 'PhoneNumber=+44 (0)20 7946 0001'

The server's JSON response structures results hierarchically. Site or managing agent details form the primary level, followed by any associated contacts. If a match occurs at the site/agent level, it's included. Matches within a site's contact list result in both the site/agent and the specific contact being listed.

For any given number, the response will include a maximum of 20 matching records, ordered by their last access date in descending order (most recent first).

Example Response

{
    "Status": "Success",
    "SearchResults": [
        {
            "ID": 85186,
            "DocID": "C40326",
            "Client": "Brooks",
            "Address": "33 Tees Crescent Teesville Kent, England DN8 8DN",
            "LandLine1": "0800 800800",
            "LandLine2": "",
            "Mobile1": "",
            "Mobile2": "",
            "Fax": "",
            "Email": "",
            "LastAccessDate": "2024-04-07 08:32:09",
            "Offset": 60,
            "Contacts": []
        },
        {
            "ID": 6970,
            "DocID": "A4714",
            "Client": "Exeter Social Housing",
            "Address": "38 Exeter Road  Test Town  EX9 9EX",
            "LandLine1": "",
            "LandLine2": "",
            "Mobile1": "",
            "Mobile2": "",
            "Fax": "",
            "Email": "sales@autovu.co.uk",
            "LastAccessDate": "2019-02-21 13:53:56",
            "Offset": 0,
            "Contacts": [
                {
                    "ContactID": 23161,
                    "DocID": "R21931",
                    "ContactName": "Julie Green",
                    "LandLine": "",
                    "Mobile": "0800 800800",
                    "Fax": "",
                    "Email": "",
                    "LastAccessDate": "2019-02-21 13:53:56",
                    "Offset": 0
                }
            ]
        }
    ],
    "ErrorMessage": "",
    "LocationID": "ContactFromPhone"
}

Field descriptions, others are self explanatory.

ID / ContactID: The internal system reference number of the contact.

DocID: The user reference number used to identify the contact within the system.

LastAccessDate: is the UTC date that the entity was last accessed.

Offset: is the number of minutes time difference between the UTC time and local time.

Notes

DocID prefixed 'C' is a Site

DocID prefixed 'A' is a Managing Agent