The Aloware LRN (Location Routing Number) identifies the phone number types stored in your Aloware contacts, such as landlines, wireless numbers, VoIP, and others. This information plays a crucial role in optimizing your SMS marketing campaigns, ensuring better conversions and delivery rates.
A good error rate is typically in the range of 0-6%
A good opt-out rate is typically in the range of 0-0.3%
By leveraging the Number Lookup API, you can tap into this feature and enhance the effectiveness of your messaging strategy.
Screenshot of a Contact with Phone Identifier
Read more about Phone Identifiers.
Enabling and Disabling the LRN Feature
To prevent undeliverable messages and maintain compliance, we highly recommend using the LRN feature. When you import or add contacts to Aloware, the platform automatically checks and saves the phone number type. If a number is identified as a landline or "spam likely," Aloware refrains from sending messages to those contacts. By default, the LRN feature is enabled for your account upon creation.
A $0.002 (two-tenth of a cent) is charged for any LRN lookup.
How to Use the Number Lookup API
This documentation provides instructions on how to use the Number Lookup API effectively.
Endpoint
POST /api/v1/webhook/lookup
Performing a Number Lookup
To perform a number lookup, you need the following required fields:
api_token | Your Aloware account API token. |
phone_number | The phone number you want to lookup in E.164 format (e.g., +18181234567). |
Example POST URL
https://app.aloware.com/api/v1/webhook/lookup
Example POST Body - Perform a number lookup
Here is an example JSON payload to perform a number lookup using the Aloware Number Lookup API:
{
"api_token": "CC42FF74",
"phone_number": "+18185005050"
}Example POST Header
Accept: application/json
Content-Type: application/json
Response
HTTP 200 - Successful number lookup.
{
"sid": "4243942058",
"line_type": "1",
"carrier": "Sprint PCS/2",
"cnam_city": "Burbank",
"cnam_state": "CA",
"cnam_country": "US",
"data": {
"tn": "4243942058",
"lrn": "818795",
"ported_status": "Y",
"ported_date": "20190104222010",
"ocn": "6664",
"line_type": "1",
"spid": "6664",
"spid_carrier_name": "Sprint PCS/2",
"spid_carrier_type": "1",
"altspid": "",
"altspid_carrier_name": "",
"altspid_carrier_type": "",
"city": "BURBANK",
"state": "California",
"country": "United States"
}
}
HTTP 400 - Failure with a detailed response.
{
"message": "The given data was invalid.",
"errors": {
"phone_number": [
"The phone number is required."
]
}
}
HTTP 404 - Number lookup unable to identify the number.
{
"error": {
"code": 404,
"message": "LRN data is empty for {number}"
}
}HTTP 500 - Failure with a detailed response.
{
"error": {
"code": 500,
"message": "Could not run lrnLookup"
}
}
cURL Example - Perform a number lookup
curl -X POST \
https://app.aloware.com/api/v1/webhook/lookup \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"api_token": "CC42FF74",
"phone_number": "+18185005050"
}'
Contact Our Support Team
If you require assistance with additional API functions or have any questions, please don't hesitate to reach out to our support team at support@aloware.com. We are dedicated to providing you with the necessary support and guidance for a seamless experience.