PowerBuilder / Plivo REST API / Search Phone Numbers
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_City
string ls_Business
string ls_Individual
string ls_Country
integer li_Lata
integer li_Mms_enabled
string ls_Mms_rate
string ls_Monthly_rental_rate
string ls_V_number
string ls_Prefix
string ls_Rate_center
string ls_Region
string ls_Resource_uri
string ls_Restriction
string ls_Restriction_text
string ls_Setup_rate
integer li_Sms_enabled
string ls_Sms_rate
string ls_Sub_type
string ls_V_type
integer li_Voice_enabled
string ls_Voice_rate
integer j
integer li_Count_j
string ls_Api_id
integer li_Limit
string ls_V_Next
integer li_Offset
string ls_Previous
integer li_Total_count
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "{{auth_id}}"
loo_Http.Password = "password"
loo_QueryParams = create oleobject
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_QueryParams.UpdateString("country_iso","US")
loo_QueryParams.UpdateString("type","local")
loo_QueryParams.UpdateInt("limit",3)
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.plivo.com/v1/Account/<auth_id>/PhoneNumber/",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// 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
ls_Api_id = loo_JResp.StringOf("api_id")
li_Limit = loo_JResp.IntOf("meta.limit")
ls_V_Next = loo_JResp.StringOf("meta.next")
li_Offset = loo_JResp.IntOf("meta.offset")
ls_Previous = loo_JResp.StringOf("meta.previous")
li_Total_count = loo_JResp.IntOf("meta.total_count")
i = 0
li_Count_i = loo_JResp.SizeOfArray("objects")
do while i < li_Count_i
loo_JResp.I = i
ls_City = loo_JResp.StringOf("objects[i].city")
ls_Business = loo_JResp.StringOf("objects[i].compliance_requirement.business")
ls_Individual = loo_JResp.StringOf("objects[i].compliance_requirement.individual")
ls_Country = loo_JResp.StringOf("objects[i].country")
li_Lata = loo_JResp.IntOf("objects[i].lata")
li_Mms_enabled = loo_JResp.BoolOf("objects[i].mms_enabled")
ls_Mms_rate = loo_JResp.StringOf("objects[i].mms_rate")
ls_Monthly_rental_rate = loo_JResp.StringOf("objects[i].monthly_rental_rate")
ls_V_number = loo_JResp.StringOf("objects[i].number")
ls_Prefix = loo_JResp.StringOf("objects[i].prefix")
ls_Rate_center = loo_JResp.StringOf("objects[i].rate_center")
ls_Region = loo_JResp.StringOf("objects[i].region")
ls_Resource_uri = loo_JResp.StringOf("objects[i].resource_uri")
ls_Restriction = loo_JResp.StringOf("objects[i].restriction")
ls_Restriction_text = loo_JResp.StringOf("objects[i].restriction_text")
ls_Setup_rate = loo_JResp.StringOf("objects[i].setup_rate")
li_Sms_enabled = loo_JResp.BoolOf("objects[i].sms_enabled")
ls_Sms_rate = loo_JResp.StringOf("objects[i].sms_rate")
ls_Sub_type = loo_JResp.StringOf("objects[i].sub_type")
ls_V_type = loo_JResp.StringOf("objects[i].type")
li_Voice_enabled = loo_JResp.BoolOf("objects[i].voice_enabled")
ls_Voice_rate = loo_JResp.StringOf("objects[i].voice_rate")
j = 0
li_Count_j = loo_JResp.SizeOfArray("objects[i].prerequisites")
do while j < li_Count_j
loo_JResp.J = j
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
