DataFlex / Plivo REST API / Update an Application
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
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"
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "answer_url": "http://answer.url",
// "answer_method": "POST",
// "hangup_url": "http://hangup.url",
// "hangup_method": "POST",
// "fallback_answer_url": "http://fallback.url",
// "fallback_method": "POST",
// "message_url": "http://message.url",
// "message_method": "POST",
// "default_number_app": "true",
// "default_endpoint_app": "true",
// "subaccount": "SAXXXXXXXXXXX",
// "log_incoming_messages": "true"
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "answer_url" "http://answer.url" To iSuccess
Get ComUpdateString Of hoJson "answer_method" "POST" To iSuccess
Get ComUpdateString Of hoJson "hangup_url" "http://hangup.url" To iSuccess
Get ComUpdateString Of hoJson "hangup_method" "POST" To iSuccess
Get ComUpdateString Of hoJson "fallback_answer_url" "http://fallback.url" To iSuccess
Get ComUpdateString Of hoJson "fallback_method" "POST" To iSuccess
Get ComUpdateString Of hoJson "message_url" "http://message.url" To iSuccess
Get ComUpdateString Of hoJson "message_method" "POST" To iSuccess
Get ComUpdateString Of hoJson "default_number_app" "true" To iSuccess
Get ComUpdateString Of hoJson "default_endpoint_app" "true" To iSuccess
Get ComUpdateString Of hoJson "subaccount" "SAXXXXXXXXXXX" To iSuccess
Get ComUpdateString Of hoJson "log_incoming_messages" "true" To iSuccess
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://api.plivo.com/v1/Account/{auth_id}/Application/{app_id}/" "application/json" vJson 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 -X POST
-u '{{auth_id}}:password'
-d '{
"answer_url": "http://answer.url",
"answer_method": "POST",
"hangup_url": "http://hangup.url",
"hangup_method": "POST",
"fallback_answer_url": "http://fallback.url",
"fallback_method": "POST",
"message_url": "http://message.url",
"message_method": "POST",
"default_number_app": "true",
"default_endpoint_app": "true",
"subaccount": "SAXXXXXXXXXXX",
"log_incoming_messages": "true"
}'
https://api.plivo.com/v1/Account/{auth_id}/Application/{app_id}/
Postman Collection Item JSON
{
"name": "Update an Application",
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"answer_url\": \"http://answer.url\",\n \"answer_method\": \"POST\",\n \"hangup_url\": \"http://hangup.url\",\n \"hangup_method\": \"POST\",\n \"fallback_answer_url\": \"http://fallback.url\",\n \"fallback_method\": \"POST\",\n \"message_url\": \"http://message.url\",\n \"message_method\": \"POST\",\n \"default_number_app\": \"true\",\n \"default_endpoint_app\": \"true\",\n \"subaccount\": \"SAXXXXXXXXXXX\",\n \"log_incoming_messages\": \"true\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.plivo.com/v1/Account/{auth_id}/Application/{app_id}/",
"protocol": "https",
"host": [
"api",
"plivo",
"com"
],
"path": [
"v1",
"Account",
"{auth_id}",
"Application",
"{app_id}",
""
]
},
"description": "Modify an application using this API.\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/account/api/application#update-an-application)\n\n| Arguments | Description | Required/Conditional/Optional |\n| :--- | :----: | ---: |\n| answer_url | The URL Plivo will fetch when a call executes this application. More details. | Required |\n| app_name | The name of your application | Required |\n| answer_method | The method used to call the answer_url. Defaults to POST. | Optional |\n| hangup_url | The URL that will be notified by Plivo when the call hangs up. Defaults to answer_url. More details. | Optional |\n| hangup_method| The method used to call the hangup_url. Defaults to POST. | Optional |\n| fallback_answer_url| Invoked by Plivo only if answer_url is unavailable or the XML response is invalid. Should contain a XML response. | Optional |\n| fallback_method| The method used to call the fallback_answer_url. Defaults to POST.| Optional |\n| message_url| The URL that will be notified by Plivo when an inbound message is received. Defaults not set.| Optional |\n| message_method| The method used to call the message_url. Defaults to POST.| Optional |\n| default_number_app| If set to true, this parameter ensures that newly created numbers, which don't have an app_id, point to this application.| Optional |\n| default_endpoint_app| If set to true, this parameter ensures that newly created endpoints, which don't have an app_id, point to this application.| Optional |\n| subaccount| ID of the subaccount to which this application needs to be associated with.| Optional |\n| log_incoming_messages| If set to false, the content of incoming messages to Plivo phone numbers associated with this application are not logged in Plivo systems, including the debug logs available on the Plivo console. Additionally, the last three digits of the from number are redacted in all system logs and in the Message Detail Record (MDR) of the incoming message.<br />log_incoming_messages defaults true when not specified.<br />Note that non-redacted content and from number is always passed to the the message_url irrespective of the value set for this flag.| Optional |"
},
"response": [
{
"name": "Update an Application",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"answer_url\": \"http://answer.url\",\n \"answer_method\": \"POST\",\n \"hangup_url\": \"http://hangup.url\",\n \"hangup_method\": \"POST\",\n \"fallback_answer_url\": \"http://fallback.url\",\n \"fallback_method\": \"POST\",\n \"message_url\": \"http://message.url\",\n \"message_method\": \"POST\",\n \"default_number_app\": \"true\",\n \"default_endpoint_app\": \"true\",\n \"subaccount\": \"SAXXXXXXXXXXX\",\n \"log_incoming_messages\": \"true\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.plivo.com/v1/Account/{auth_id}/Application/{app_id}/",
"protocol": "https",
"host": [
"api",
"plivo",
"com"
],
"path": [
"v1",
"Account",
"{auth_id}",
"Application",
"{app_id}",
""
]
}
},
"code": 200,
"_postman_previewlanguage": "json",
"header": [
],
"cookie": [
],
"body": "{\n \"message\": \"changed\",\n \"api_id\": \"5a9fcb68-582d-11e1-86da-6ff39efcb949\"\n}"
}
]
}
