Foxpro / Plivo REST API / Search Phone Numbers
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCity
LOCAL lcBusiness
LOCAL lcIndividual
LOCAL lcCountry
LOCAL lnLata
LOCAL lnMms_enabled
LOCAL lcMms_rate
LOCAL lcMonthly_rental_rate
LOCAL lcV_number
LOCAL lcPrefix
LOCAL lcRate_center
LOCAL lcRegion
LOCAL lcResource_uri
LOCAL lcRestriction
LOCAL lcRestriction_text
LOCAL lcSetup_rate
LOCAL lnSms_enabled
LOCAL lcSms_rate
LOCAL lcSub_type
LOCAL lcV_type
LOCAL lnVoice_enabled
LOCAL lcVoice_rate
LOCAL j
LOCAL lnCount_j
LOCAL lcApi_id
LOCAL lnLimit
LOCAL lcV_Next
LOCAL lnOffset
LOCAL lcPrevious
LOCAL lnTotal_count
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.BasicAuth = 1
loHttp.Login = "{{auth_id}}"
loHttp.Password = "password"
loQueryParams = CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams.UpdateString("country_iso","US")
loQueryParams.UpdateString("type","local")
loQueryParams.UpdateInt("limit",3)
loResp = loHttp.QuickRequestParams("GET","https://api.plivo.com/v1/Account/<auth_id>/PhoneNumber/",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "api_id": "1a75dad2-5ef4-11eb-91fe-0242ac110003",
* "meta": {
* "limit": 3,
* "next": "/v1/Account/MAMDC1NTE3ZGQ4NWNJNM/PhoneNumber/?limit=3&offset=3&type=local&country_iso=US",
* "offset": 0,
* "previous": null,
* "total_count": 14227
* },
* "objects": [
* {
* "city": "Saddleback Valley",
* "compliance_requirement": {
* "business": null,
* "individual": null
* },
* "country": "UNITED STATES",
* "lata": 730,
* "mms_enabled": true,
* "mms_rate": "0.00400",
* "monthly_rental_rate": "0.18000",
* "number": "19496031645",
* "prefix": "949",
* "prerequisites": [
* ],
* "rate_center": "Saddleback Valley",
* "region": "California",
* "resource_uri": "/v1/Account/MAMDC1NTE3ZGQ4NWNJNM/PhoneNumber/19496031645/",
* "restriction": "",
* "restriction_text": "",
* "setup_rate": "0.00000",
* "sms_enabled": true,
* "sms_rate": "0.00000",
* "sub_type": "local",
* "type": "fixed",
* "voice_enabled": true,
* "voice_rate": "0.00300"
* },
* {
* "city": "Elwin",
* "compliance_requirement": {
* "business": null,
* "individual": null
* },
* "country": "UNITED STATES",
* "lata": 374,
* "mms_enabled": true,
* "mms_rate": "0.00400",
* "monthly_rental_rate": "0.18000",
* "number": "12177674383",
* "prefix": "217",
* "prerequisites": [
* ],
* "rate_center": "Elwin",
* "region": "Illinois",
* "resource_uri": "/v1/Account/MAMDC1NTE3ZGQ4NWNJNM/PhoneNumber/12177674383/",
* "restriction": "",
* "restriction_text": "",
* "setup_rate": "0.00000",
* "sms_enabled": true,
* "sms_rate": "0.00000",
* "sub_type": "local",
* "type": "fixed",
* "voice_enabled": true,
* "voice_rate": "0.00300"
* },
* {
* "city": "Westwood",
* "compliance_requirement": {
* "business": null,
* "individual": null
* },
* "country": "UNITED STATES",
* "lata": 224,
* "mms_enabled": true,
* "mms_rate": "0.00400",
* "monthly_rental_rate": "0.18000",
* "number": "15513105271",
* "prefix": "551",
* "prerequisites": [
* ],
* "rate_center": "Westwood",
* "region": "New Jersey",
* "resource_uri": "/v1/Account/MAMDC1NTE3ZGQ4NWNJNM/PhoneNumber/15513105271/",
* "restriction": "",
* "restriction_text": "",
* "setup_rate": "0.00000",
* "sms_enabled": true,
* "sms_rate": "0.00000",
* "sub_type": "local",
* "type": "fixed",
* "voice_enabled": true,
* "voice_rate": "0.00300"
* }
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcApi_id = loJResp.StringOf("api_id")
lnLimit = loJResp.IntOf("meta.limit")
lcV_Next = loJResp.StringOf("meta.next")
lnOffset = loJResp.IntOf("meta.offset")
lcPrevious = loJResp.StringOf("meta.previous")
lnTotal_count = loJResp.IntOf("meta.total_count")
i = 0
lnCount_i = loJResp.SizeOfArray("objects")
DO WHILE i < lnCount_i
loJResp.I = i
lcCity = loJResp.StringOf("objects[i].city")
lcBusiness = loJResp.StringOf("objects[i].compliance_requirement.business")
lcIndividual = loJResp.StringOf("objects[i].compliance_requirement.individual")
lcCountry = loJResp.StringOf("objects[i].country")
lnLata = loJResp.IntOf("objects[i].lata")
lnMms_enabled = loJResp.BoolOf("objects[i].mms_enabled")
lcMms_rate = loJResp.StringOf("objects[i].mms_rate")
lcMonthly_rental_rate = loJResp.StringOf("objects[i].monthly_rental_rate")
lcV_number = loJResp.StringOf("objects[i].number")
lcPrefix = loJResp.StringOf("objects[i].prefix")
lcRate_center = loJResp.StringOf("objects[i].rate_center")
lcRegion = loJResp.StringOf("objects[i].region")
lcResource_uri = loJResp.StringOf("objects[i].resource_uri")
lcRestriction = loJResp.StringOf("objects[i].restriction")
lcRestriction_text = loJResp.StringOf("objects[i].restriction_text")
lcSetup_rate = loJResp.StringOf("objects[i].setup_rate")
lnSms_enabled = loJResp.BoolOf("objects[i].sms_enabled")
lcSms_rate = loJResp.StringOf("objects[i].sms_rate")
lcSub_type = loJResp.StringOf("objects[i].sub_type")
lcV_type = loJResp.StringOf("objects[i].type")
lnVoice_enabled = loJResp.BoolOf("objects[i].voice_enabled")
lcVoice_rate = loJResp.StringOf("objects[i].voice_rate")
j = 0
lnCount_j = loJResp.SizeOfArray("objects[i].prerequisites")
DO WHILE j < lnCount_j
loJResp.J = j
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -G -d "country_iso=US"
-d "type=local"
-d "limit=3"
-u '{{auth_id}}:password'
https://api.plivo.com/v1/Account/<auth_id>/PhoneNumber/
Postman Collection Item JSON
{
"name": "Search Phone Numbers",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.plivo.com/v1/Account/{{auth_id}}/PhoneNumber/?country_iso=US&type=local&limit=3",
"protocol": "https",
"host": [
"api",
"plivo",
"com"
],
"path": [
"v1",
"Account",
"{{auth_id}}",
"PhoneNumber",
""
],
"query": [
{
"key": "country_iso",
"value": "US",
"description": "The ISO country code of the country."
},
{
"key": "type",
"value": "local",
"description": "Filters by the type of the phone number. Possible values are tollfree, local, mobile, national and fixed."
},
{
"key": "pattern",
"value": "615",
"description": "A pattern to match the phone number with. Phone numbers starting with (country calling code + pattern) are filtered in.",
"disabled": true
},
{
"key": "region",
"value": "California",
"description": "You could use the exact name of the region, for instance region=Frankfurt for a phone number in Frankfurt.",
"disabled": true
},
{
"key": "services",
"value": "voice",
"description": "Filters phone numbers which provide the selected services such as voice, sms & mms",
"disabled": true
},
{
"key": "city",
"value": "New York",
"description": "Filter phone number based on the city name. This filter is only applicable when the type is Local.",
"disabled": true
},
{
"key": "lata",
"value": "722",
"description": "Filters phone numbers in a LATA. This filter is applicable only for US and Canada",
"disabled": true
},
{
"key": "rate_center",
"value": "310615",
"description": "Filters phone numbers based on the rate center. This filter is applicable only for US and Canada.",
"disabled": true
},
{
"key": "limit",
"value": "3",
"description": "A limit on the number phone numbers to be returned. limit can range between 1 and 20, and the default is 20."
},
{
"key": "offset",
"value": "0",
"description": "Denotes the number of value items by which the results should be offset. Defaults to 0",
"disabled": true
}
]
},
"description": "Returns a list of phone numbers that are available for purchase. You can search for tollfree, mobile, local, national and fixed phone numbers. The API allows you to filter phone numbers based on the country_iso, pattern, type and region.\n\nBelow is the list of arguments that can be passed in this API request, more information can be found [here](https://www.plivo.com/docs/numbers/api/phone-number#search-phone-numbers)\n\n| Arguments | Description | Required/Conditional/Optional |\n| :--- | :----: | ---: |\n| country_iso | The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the country. For more information on supported countries, refer to our incoming [Voice](https://www.plivo.com/voice/coverage/us/) and [SMS](https://www.plivo.com/sms/coverage/us/) coverage.| Required |\n| type | Filters by the type of the phone number. Possible values are tollfree, local, mobile, national and fixed.| Optional |\n| pattern | A pattern to match the phone number with. Phone numbers starting with (country calling code + pattern) are filtered in. The allowed values are A-Z, 0-9, *, and ?.For example, in order to search for phone numbers in the US starting with 415 prefix, Pattern = 415. Filtered results will be of form '1415XXXXXXX'.| Optional |\n| region | This filter is only applicable when the type is fixed. If the type is not provided, it is assumed to be fixed. You could use the exact name of the region, for instance region=Frankfurt for a phone number in Frankfurt.| Optional |\n| services | Filters phone numbers which provide the selected services . Possible values are:<br />voice: Indicates that phone numbers which can receive calls are to be returned.<br />sms: Indicates that phone numbers which can receive SMS are to be returned.<br />mms: Indicates that phone numbers that can receive MMS are to be returned.<br />voice,sms: Indicates that phone numbers which can receive both calls and SMS are to be returned.<br />voice,sms,mms: Indicates that phone numbers that can receive calls, SMS and MMS are to be returned.| Optional |\n| city | Filter phone number based on the city name. This filter is only applicable when the type is Local.| Optional |\n| lata | Filters phone numbers in a [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area). This filter is applicable only for US and Canada.| Optional |\n| rate_center | Filters phone numbers based on the [rate center](https://www.plivo.com/docs/numbers/api/phone-number/). This filter is applicable only for US and Canada.| Optional |\n| limit | A limit on the number phone numbers to be returned. limit can range between 1 and 20, and the default is 20.| Optional |\n| offset | Denotes the number of value items by which the results should be offset. Defaults to 0. Read more about offset based pagination [here](https://www.plivo.com/docs/numbers/api/request/pagination/).| Optional |"
},
"response": [
{
"name": "Search Phone Numbers",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.plivo.com/v1/Account/{{auth_id}}/PhoneNumber/?country_iso=US&type=local&limit=3",
"protocol": "https",
"host": [
"api",
"plivo",
"com"
],
"path": [
"v1",
"Account",
"{{auth_id}}",
"PhoneNumber",
""
],
"query": [
{
"key": "country_iso",
"value": "US",
"description": "The ISO country code of the country."
},
{
"key": "type",
"value": "local",
"description": "Filters by the type of the phone number. Possible values are tollfree, local, mobile, national and fixed."
},
{
"key": "pattern",
"value": "615",
"description": "A pattern to match the phone number with. Phone numbers starting with (country calling code + pattern) are filtered in.",
"disabled": true
},
{
"key": "region",
"value": "California",
"description": "You could use the exact name of the region, for instance region=Frankfurt for a phone number in Frankfurt.",
"disabled": true
},
{
"key": "services",
"value": "voice",
"description": "Filters phone numbers which provide the selected services such as voice, sms & mms",
"disabled": true
},
{
"key": "city",
"value": "New York",
"description": "Filter phone number based on the city name. This filter is only applicable when the type is Local.",
"disabled": true
},
{
"key": "lata",
"value": "722",
"description": "Filters phone numbers in a LATA. This filter is applicable only for US and Canada",
"disabled": true
},
{
"key": "rate_center",
"value": "310615",
"description": "Filters phone numbers based on the rate center. This filter is applicable only for US and Canada.",
"disabled": true
},
{
"key": "limit",
"value": "3",
"description": "A limit on the number phone numbers to be returned. limit can range between 1 and 20, and the default is 20."
},
{
"key": "offset",
"value": "0",
"description": "Denotes the number of value items by which the results should be offset. Defaults to 0",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 25 Jan 2021 10:00:07 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "2570"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Server",
"value": "nginx"
},
{
"key": "X-Plivo-Signature",
"value": "rFbFXY06oMSqyKlhf3Q/V7gady8="
},
{
"key": "X-Plivo-Signature-V2",
"value": "sYe601dE/b7eGEzwEiXOW1ygErn3SFdEmNxu6/hNubw="
},
{
"key": "X-Plivo-Signature-MA-V2",
"value": "sYe601dE/b7eGEzwEiXOW1ygErn3SFdEmNxu6/hNubw="
},
{
"key": "X-Plivo-Signature-V2-Nonce",
"value": "98286916815782313309"
}
],
"cookie": [
],
"body": "{\n \"api_id\": \"1a75dad2-5ef4-11eb-91fe-0242ac110003\",\n \"meta\": {\n \"limit\": 3,\n \"next\": \"/v1/Account/MAMDC1NTE3ZGQ4NWNJNM/PhoneNumber/?limit=3&offset=3&type=local&country_iso=US\",\n \"offset\": 0,\n \"previous\": null,\n \"total_count\": 14227\n },\n \"objects\": [\n {\n \"city\": \"Saddleback Valley\",\n \"compliance_requirement\": {\n \"business\": null,\n \"individual\": null\n },\n \"country\": \"UNITED STATES\",\n \"lata\": 730,\n \"mms_enabled\": true,\n \"mms_rate\": \"0.00400\",\n \"monthly_rental_rate\": \"0.18000\",\n \"number\": \"19496031645\",\n \"prefix\": \"949\",\n \"prerequisites\": [],\n \"rate_center\": \"Saddleback Valley\",\n \"region\": \"California\",\n \"resource_uri\": \"/v1/Account/MAMDC1NTE3ZGQ4NWNJNM/PhoneNumber/19496031645/\",\n \"restriction\": \"\",\n \"restriction_text\": \"\",\n \"setup_rate\": \"0.00000\",\n \"sms_enabled\": true,\n \"sms_rate\": \"0.00000\",\n \"sub_type\": \"local\",\n \"type\": \"fixed\",\n \"voice_enabled\": true,\n \"voice_rate\": \"0.00300\"\n },\n {\n \"city\": \"Elwin\",\n \"compliance_requirement\": {\n \"business\": null,\n \"individual\": null\n },\n \"country\": \"UNITED STATES\",\n \"lata\": 374,\n \"mms_enabled\": true,\n \"mms_rate\": \"0.00400\",\n \"monthly_rental_rate\": \"0.18000\",\n \"number\": \"12177674383\",\n \"prefix\": \"217\",\n \"prerequisites\": [],\n \"rate_center\": \"Elwin\",\n \"region\": \"Illinois\",\n \"resource_uri\": \"/v1/Account/MAMDC1NTE3ZGQ4NWNJNM/PhoneNumber/12177674383/\",\n \"restriction\": \"\",\n \"restriction_text\": \"\",\n \"setup_rate\": \"0.00000\",\n \"sms_enabled\": true,\n \"sms_rate\": \"0.00000\",\n \"sub_type\": \"local\",\n \"type\": \"fixed\",\n \"voice_enabled\": true,\n \"voice_rate\": \"0.00300\"\n },\n {\n \"city\": \"Westwood\",\n \"compliance_requirement\": {\n \"business\": null,\n \"individual\": null\n },\n \"country\": \"UNITED STATES\",\n \"lata\": 224,\n \"mms_enabled\": true,\n \"mms_rate\": \"0.00400\",\n \"monthly_rental_rate\": \"0.18000\",\n \"number\": \"15513105271\",\n \"prefix\": \"551\",\n \"prerequisites\": [],\n \"rate_center\": \"Westwood\",\n \"region\": \"New Jersey\",\n \"resource_uri\": \"/v1/Account/MAMDC1NTE3ZGQ4NWNJNM/PhoneNumber/15513105271/\",\n \"restriction\": \"\",\n \"restriction_text\": \"\",\n \"setup_rate\": \"0.00000\",\n \"sms_enabled\": true,\n \"sms_rate\": \"0.00000\",\n \"sub_type\": \"local\",\n \"type\": \"fixed\",\n \"voice_enabled\": true,\n \"voice_rate\": \"0.00300\"\n }\n ]\n}"
}
]
}
