Smart Carrier | API Key | Purchase Telephone Numbers

The Purchase Telephone 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:

Purchase Telephone Numbers:

Endpoint:

https://api.smartcarrier.io/v2/purchase-numbers?

Method:

Parameters:

AreaCode: Any valid Area Code

Example: 212, 315, 949, etc.

Quantity: The Quantity desired.

Example: 1, 2, 3, etc.

RoutingContainer: The inbound routing container you would like the calls to this number to go to. You may find your routing containers here - https://app.smartcarrier.io/calls/inbound/settings

Example: 1234

Geoproximation: This is an optional parameter and will search neighboring area codes in the event a number is not available in the area codes requested.

Example: 0 or false or 1 or true.

Headers:

x-api-key: Your API key.

Sample Request without Geoproximation: https://api.smartcarrier.io/v2/purchase-numbers?AreaCode=212&Quantity=1&RoutingContainer=1234
Sample Request with Geoproximation: https://api.smartcarrier.io/v2/purchase-numbers?AreaCode=212&Quantity=1&RoutingContainer=1234&Geoproximation=1

or https://api.smartcarrier.io/v2/purchase-numbers?AreaCode=212&Quantity=1&RoutingContainer=1234&Geoproximation=0

Response:
{
"ProviderGuid": "00000000-0000-0000-0000-000000000000",
"AccountGuid": "ecad22d2-22ee-4a94-b7e8-f33cd5a2485f",
"LergInformation": {
"RequestGuid": "c482c10e-2154-469f-ba19-8f64936135e6",
"RoutingNumber": null,
"NPANXX": 0,
"Block": null,
"USState": null,
"AssignedTo": null,
"AssignedTo_OCN": null,
"Type": null,
"Ilec": null,
"Ilec_OCN": null,
"Lata": null,
"TollFree": false,
"IsValid": true,
"RequestedAt": "2023-10-23T21:09:46.9894485Z",
"ElapsedMilliseconds": 0
},
"AreaCodeRequested": 212,
"Quantity": 1,
"RoutingContainer": 1234,
"Geoproximation": false,
"DIDResponse": [
"2125551212"
],
"RequestCost": "$0.45",
"DateTimeRequested": "2023-10-23T21:09:46.9894542Z",
"ResponseCode": 200,
"ResponseMessage": "Success"
}

What do the response values mean?

ProviderGuid: a unique identifier assigned to the telephone number's carrier network.
AccountGuid: the account's unique identifier.
LergInformation: Details with respect to the from number's rate center.
AreaCodeRequested: The area code requested.
Quantity: The number of telephone numbers requested.
RoutingContainer: The inbound routing container selected.
Geoproximation: Whether or not Geoproximaton was requested.
DIDResponse: An array containing the telephone numbers requested. If no numbers are available, then 'No Numbers Available' will be displayed.
RequestCost: The amount of money for this request.
DateTimeRequested: The date and time of the request.
ResponseMessage: A friendly representation of the request's status.
ResponseCode:

200: Successful
503: ReturnStatus will contain the reason.