DataFlex / Plivo REST API / List account phone numbers
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
String sTemp1
Integer iTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "{{auth_id}}"
Set ComPassword Of hoHttp To "password"
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateInt Of hoQueryParams "limit" 5 To iSuccess
Get ComUpdateInt Of hoQueryParams "offset" 0 To iSuccess
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api.plivo.com/v1/Account/<auth_id>/Number/" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
Showln iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
Send Destroy of hoResp
End_Procedure
Curl Command
curl -G -d "limit=5"
-d "offset=0"
-u '{{auth_id}}:password'
https://api.plivo.com/v1/Account/<auth_id>/Number/
Postman Collection Item JSON
{
"name": "List account phone numbers",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Number/?limit=5&offset=0",
"protocol": "https",
"host": [
"api",
"plivo",
"com"
],
"path": [
"v1",
"Account",
"{{auth_id}}",
"Number",
""
],
"query": [
{
"key": "type",
"value": "local",
"description": "The type of number. You can filter by local, mobile, fixed, national and tollfree numbers.",
"disabled": true
},
{
"key": "number_startswith",
"value": "95",
"description": "Only show the phone numbers that begin with this pattern.",
"disabled": true
},
{
"key": "subaccount",
"value": "SAXXXXXXXX",
"description": "Returns phone numbers associated to this sub account.",
"disabled": true
},
{
"key": "alias",
"value": "testalias",
"description": "Returns phone numbers that exactly match this alias.",
"disabled": true
},
{
"key": "services",
"value": "voice",
"description": "Filters phone numbers which provide the selected services",
"disabled": true
},
{
"key": "limit",
"value": "5",
"description": "Used to display the number of results per page. The maximum number of results that can be fetched is 20. Defaults to 20."
},
{
"key": "offset",
"value": "0",
"description": "Denotes the number of value items by which the results should be offset. Defaults to 0"
}
]
},
"description": "Returns a list of phone numbers that you’ve rented from Plivo or [added from your carrier](https://www.plivo.com/docs/numbers/api/account-phone-number/#docs-numbers-api-incoming-carrier).\n\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/account-phone-number#list-all-my-numbers)\n\n| Arguments | Description | Required/Conditional/Optional |\n| :--- | :----: | ---: |\n| type | The type of number. You can filter by local, mobile, fixed, national and tollfree numbers.| Optional |\n| number_startswith | Only show the phone numbers that begin with this pattern.| Optional |\n| subaccount | Returns phone numbers associated to this sub account.| Optional |\n| alias | Returns phone numbers that exactly match this alias.| 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| limit | Used to display the number of results per page. The maximum number of results that can be fetched is 20. Defaults to 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": [
]
}