Smart Carrier | API Key | AI Numbers

Smart Carrier | API Key | AI Numbers



The AI Numbers web service is a RESTful-compliant and may be accessed via HTTPS using an API Key. You may obtain your API Key from your web portal or from your Smart Carrier Account Representative. All results are returned as JSON. Charges may apply to use this API.

Below, please find the endpoints and examples:

AI Numbers:

  • Endpoint:

    •  https://api.smartcarrier.io/v2/ai-numbers?

  • Method:

    • GET

  • Parameters:

    • ToNumber: Any correctly formatted telephone number.

      • Example: 3155564800, 13155564800, +13155564800

    • FromNumber: Any correctly formatted telephone number.

      • Example: 8003816311, 8003816311, +18003816311

  • Headers:

    • x-api-key: Your API key.

  • Sample Request: https://api.smartcarrier.io/v2/ai-numbers?ToNumber=3155564800&FromNumber=8003816311

  • Response: { "RequestGuid": "90fc3aba-6fb1-4364-a917-5f69d9de1e44", "AccountGuid": "98e942d7-fb1a-4885-84bb-71df714c2580", "DNIS": "13155564800", "DNIS_Valid": true, "DNIS_TollFree": false, "RoutingNumber": "13158046199", "DNIS_InService": true, "DNIS_NationalDNC": false, "Lerg_DNIS": { "RequestGuid": "16bd0d73-21e3-4f12-b349-8bc2c7b16be2", "NPANXX": 1315804, "Block": "6", "USState": "NY", "AssignedTo": "Technology Innovation Lab - NY", "AssignedTo_OCN": "560J", "Type": "CLEC", "Ilec": "VERIZON NEW YORK, INC.", "Ilec_OCN": "9104", "Lata": "136", "RequestedAt": "2022-06-27T17:16:59.1595238Z", "ElapsedMilliseconds": 7 }, "ANI": "8003816311", "ANI_Valid": true, "ANI_TollFree": true, "Lerg_ANI": { "RequestGuid": "0e422236-be2c-49aa-a76a-2082d61098db", "NPANXX": 0, "Block": "A", "USState": null, "AssignedTo": null, "AssignedTo_OCN": null, "Type": null, "Ilec": null, "Ilec_OCN": null, "Lata": null, "RequestedAt": "2022-06-27T17:22:00.7301951Z", "ElapsedMilliseconds": 19 }, "UseANI": "2125551212", "AINumbers": true, "RequestedAt": "2022-05-10T20:29:42.3244789Z", "CompletedAt": "2022-05-10T20:29:42.3670615Z", "ElapsedTimeMS": 47, "ReturnCode": 200, "ReturnStatus": "Success" }


What do the response values mean?

  • RequestGuid: a unique identifier assigned to this request.

  • AccountGuid: the account's unique identifier.

  • DNIS: The number you are attempting to call.

  • DNIS_Valid: Is the telephone number you are attempting to call valid.

  • DNIS_TollFree: Is the telephone number you are attempting to call a toll free number.

  • RoutingNumber: If the destination number was ported, the routing number assigned.

  • DNIS_InService: If subscribed, whether or not this number is in service or if it is disconnected.

  • DNIS_NationalDNC: If subscribed, whether or not the destination number is in service.

  • LERG_DNIS: Details with respect to the destination number's rate center.

  • ANI:  The original from number sent to us.

  • ANI_Valid: Is the from number valid.

  • ANI_TollFree: Is the from number a toll free number.

  • LERG_ANI:  Details with respect to the from number's rate center.

  • UseANI: The telephone number to use as a caller ID.

  • RequestedAt:  The time, in UTC, of when the request was received.

  • CompletedAt:  The time, in UTC, of when the request was completed.

  • ElapsedTimeMS:  The amount of time, in milliseconds, required to process this request.

    • Result_CrowdsourcingAPI: If a request was made to the Carrier API - is the number flagged.

  • ReturnCode:

    • 200: Successful

    • 404: ReturnStatus will contain the reason.

    • 503: ReturnStatus will contain the reason.