Below, please find the endpoints and examples:
AI Numbers:
Endpoint:
https://api.smartcarrier.io/v2/ai-numbers-hosted-numbers?
Method:
GET
Parameters:
TelephoneNumber: Any correctly formatted telephone number.
Example: 3155564800, 13155564800, +13155564800
Operation: Determine if you would like to add or remove telephone number from your hosted repository
1: Add number to repository.
0: Remove number from repository.
Headers:
x-api-key: Your API key.
Sample Request: https://api.smartcarrier.io/v2/ai-numbers-hosted-numbers?TelephoneNumber=13155564800
Response:
{
"RequestGuid": "90fc3aba-6fb1-4364-a917-5f69d9de1e44",
"AccountGuid": "98e942d7-fb1a-4885-84bb-71df714c2580",
"TelephoneNumber": "13155564800",
"Operation":"1"
"RequestedAt": "2022-05-10T20:29:42.3244789Z",
"CompletedAt": "2022-05-10T20:29:42.3670615Z",
"ElapsedTimeMS": 12,
"ReturnCode": 200,
"ReturnStatus": "Success - Number Queued."
}
What do the response values mean?
RequestGuid: a unique identifier assigned to this request.
AccountGuid: the account's unique identifier.
TelephoneNumber: The number requested to be added or removed.
Operation: The operation requested.
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.