VB6 / Plivo REST API / Search Phone Numbers
Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
http.BasicAuth = 1
http.Login = "{{auth_id}}"
http.Password = "password"
Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("country_iso","US")
success = queryParams.UpdateString("type","local")
success = queryParams.UpdateInt("limit",3)
Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://api.plivo.com/v1/Account/<auth_id>/PhoneNumber/",queryParams)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' 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
Dim city As String
Dim Business As String
Dim Individual As String
Dim country As String
Dim lata As Long
Dim mms_enabled As Long
Dim mms_rate As String
Dim monthly_rental_rate As String
Dim v_number As String
Dim prefix As String
Dim rate_center As String
Dim region As String
Dim resource_uri As String
Dim restriction As String
Dim restriction_text As String
Dim setup_rate As String
Dim sms_enabled As Long
Dim sms_rate As String
Dim sub_type As String
Dim v_type As String
Dim voice_enabled As Long
Dim voice_rate As String
Dim j As Long
Dim count_j As Long
Dim api_id As String
api_id = jResp.StringOf("api_id")
Dim Limit As Long
Limit = jResp.IntOf("meta.limit")
Dim v_Next As String
v_Next = jResp.StringOf("meta.next")
Dim Offset As Long
Offset = jResp.IntOf("meta.offset")
Dim Previous As String
Previous = jResp.StringOf("meta.previous")
Dim Total_count As Long
Total_count = jResp.IntOf("meta.total_count")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("objects")
Do While i < count_i
jResp.I = i
city = jResp.StringOf("objects[i].city")
Business = jResp.StringOf("objects[i].compliance_requirement.business")
Individual = jResp.StringOf("objects[i].compliance_requirement.individual")
country = jResp.StringOf("objects[i].country")
lata = jResp.IntOf("objects[i].lata")
mms_enabled = jResp.BoolOf("objects[i].mms_enabled")
mms_rate = jResp.StringOf("objects[i].mms_rate")
monthly_rental_rate = jResp.StringOf("objects[i].monthly_rental_rate")
v_number = jResp.StringOf("objects[i].number")
prefix = jResp.StringOf("objects[i].prefix")
rate_center = jResp.StringOf("objects[i].rate_center")
region = jResp.StringOf("objects[i].region")
resource_uri = jResp.StringOf("objects[i].resource_uri")
restriction = jResp.StringOf("objects[i].restriction")
restriction_text = jResp.StringOf("objects[i].restriction_text")
setup_rate = jResp.StringOf("objects[i].setup_rate")
sms_enabled = jResp.BoolOf("objects[i].sms_enabled")
sms_rate = jResp.StringOf("objects[i].sms_rate")
sub_type = jResp.StringOf("objects[i].sub_type")
v_type = jResp.StringOf("objects[i].type")
voice_enabled = jResp.BoolOf("objects[i].voice_enabled")
voice_rate = jResp.StringOf("objects[i].voice_rate")
j = 0
count_j = jResp.SizeOfArray("objects[i].prerequisites")
Do While j < count_j
jResp.J = j
j = j + 1
Loop
i = i + 1
Loop
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}"
}
]
}
