---
title: "HLR number lookup with results going to a callback URL"
method: GET
path: "/hlr-callback/"
tags: ["HLR"]
---

# HLR number lookup with results going to a callback URL

`GET /hlr-callback/`

## Request

- Base URL: `http://api.smsfusion.com.au`
- URL: `http://api.smsfusion.com.au/hlr-callback/`
- Auth: API key in query parameter `key`

Queue HLR lookups for one or more numbers. This endpoint is always asynchronous: the 200 response is only an acknowledgment of the batch (cost and any numbers that failed local format validation). Each number's actual lookup result is POSTed to the callback URL separately, as 'result=', whenever that lookup completes - there is no bound on how long after this response that happens. Served by the same script as /hlr/, selected by supplying cb

## Query parameters

- `key` string, required
- `num` string[], required
- `cb` string, required
- `cc` string, string

## Response `200`

Batch accepted. This is an acknowledgment only, not the lookup result: each number's result is POSTed to the callback URL separately and asynchronously as it becomes available

- HLRResult
  - `status` string
  - `success` integer[]
  - `failure` integer[]
  - `cost` number, float: Cost of the response
  - `callback` string: Callback URL provided

## Other responses

- `401`: Authentication failed or paramaters not provided
- `429`: Out of credit

---

[API](https://skmtc.dev/smsfusion/apis/sms-fusion-api.md) · [All operations](https://skmtc.dev/smsfusion/apis/sms-fusion-api/llms.txt) · [OpenAPI document](https://skmtc.dev/smsfusion/apis/sms-fusion-api/revisions/a88b2793a6e9?raw)