Get Number Details

About

Retrieve carrier and porting details for one or more phone numbers using the following request. This endpoint returns information about the assigned and current carrier, numbering area, porting status, and other details sourced from the ACMA database.

Resource URI

Retrieve number details by providing a comma-separated list of phone numbers.

GET
/v2/Numbers/Details

Request

Required Parameters

Parameter	Type	Description
Numbers	string	A comma-separated list of phone numbers to look up. Numbers can be provided in local format (e.g. 0491012345) or E.164 format.

Example Request

GET /v2/Numbers/Details?Numbers=0491012345,0421012345,123456789

Response

200 – OK

Our service will respond to every number details request with JSON formatted data containing carrier and porting information for each requested number.

Response Parameters

Parameter	Type	Description
numbers	array	A list of number detail objects, one per requested number.
e164	integer	The phone number in E.164 numeric format (without the + prefix).
assignedCarrier	object	The carrier the number was originally assigned to.
CAC	integer	The Carrier Access Code of the carrier. -1 if unknown.
name	string	The name of the carrier. Empty string if unknown.
currentCarrier	object	The carrier the number is currently with (may differ from assigned carrier if the number has been ported).
CAC	integer	The Carrier Access Code of the current carrier. -1 if unknown.
name	string	The name of the current carrier. Empty string if unknown.
numberingArea	string	The numbering area classification (e.g. Mobile, Sydney, Melbourne). Empty string if not found.
portedActionIndicator	string	Indicates any porting action status. Empty string if no porting action.
thirdParty	boolean	Whether the number is associated with a third party.
alreadyPorting	integer	Indicates whether the number is already in a porting process. -1 if not applicable.
reason	string	Additional context about the number lookup result (e.g. Not an Australian fixed line, Could not find it in ACMA).

Example Response

{
  "numbers": [
    {
      "e164": 123456789,
      "assignedCarrier": {
        "CAC": -1,
        "name": ""
      },
      "currentCarrier": {
        "CAC": -1,
        "name": ""
      },
      "numberingArea": "",
      "portedActionIndicator": "",
      "thirdParty": false,
      "alreadyPorting": -1,
      "reason": "Could not find it in ACMA"
    },
    {
      "e164": 61491012345,
      "assignedCarrier": {
        "CAC": 1411,
        "name": "Telstra"
      },
      "currentCarrier": {
        "CAC": 1411,
        "name": "Telstra"
      },
      "numberingArea": "Mobile",
      "portedActionIndicator": "",
      "thirdParty": false,
      "alreadyPorting": -1,
      "reason": "Not an Australian fixed line"
    },
    {
      "e164": 61421012345,
      "assignedCarrier": {
        "CAC": 1456,
        "name": "Optus"
      },
      "currentCarrier": {
        "CAC": 1456,
        "name": "Optus"
      },
      "numberingArea": "Mobile",
      "portedActionIndicator": "",
      "thirdParty": false,
      "alreadyPorting": -1,
      "reason": "Not an Australian fixed line"
    }
  ]
}

400 – Error

For error codes and messages, please refer to the REST API Error Codes page.