Chilkat Online Tools

PureBasic / Plivo REST API / Update an account phone number

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "{{auth_id}}")
    CkHttp::setCkPassword(http, "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.

    ; {
    ;   "app_id": "77494029089751836",
    ;   "subaccount": "SAXXXXXXXXXX",
    ;   "alias": "Updated Alias"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"app_id","77494029089751836")
    CkJsonObject::ckUpdateString(json,"subaccount","SAXXXXXXXXXX")
    CkJsonObject::ckUpdateString(json,"alias","Updated Alias")

    resp.i = CkHttp::ckPostJson3(http,"https://api.plivo.com/v1/Account/<auth_id>/Number/{number}/","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "app_id": "77494029089751836",
    "subaccount": "SAXXXXXXXXXX",
    "alias": "Updated Alias"
}'
https://api.plivo.com/v1/Account/<auth_id>/Number/{number}/

Postman Collection Item JSON

{
  "name": "Update an account phone number",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"app_id\": \"77494029089751836\",\n    \"subaccount\": \"SAXXXXXXXXXX\",\n    \"alias\": \"Updated Alias\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Number/{number}/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Number",
        "{number}",
        ""
      ]
    },
    "description": "Change the application and sub-account associated to specified phone number from your account.\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#update-a-number)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| app_id      | The application to be assigned to the phone number. If not specified, the application selected as the default_number_app of the Account is assigned. For more information, refer default_number_app argument in [application](https://www.plivo.com/docs/account/api/application/#create-an-application) and app_id attribute in [application object](https://www.plivo.com/docs/account/api/application#the-application-object)| Optional  |\n| subaccount      | The auth_id of the subaccount to which this number should be added. This can be performed only by the main account.| Optional  |\n| alias      | An alias assigned to the phone number.| Optional  |"
  },
  "response": [
  ]
}