Chilkat Online Tools

DataFlex / Plivo REST API / Create an endpoint

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

    // 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.

    // {
    //   "username": "testusername",
    //   "password": "testpassword",
    //   "alias": "Test Account",
    //   "app_id": "77494029089751836"
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "username" "testusername" To iSuccess
    Get ComUpdateString Of hoJson "password" "testpassword" To iSuccess
    Get ComUpdateString Of hoJson "alias" "Test Account" To iSuccess
    Get ComUpdateString Of hoJson "app_id" "77494029089751836" To iSuccess

    Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
    If (Not(IsComObjectCreated(hoResp))) Begin
        Send CreateComObject of hoResp
    End
    Get pvComObject of hoJson to vJson
    Get pvComObject of hoResp to vResp
    Get ComHttpJson Of hoHttp "POST" "https://api.plivo.com/v1/Account/<auth_id>/Endpoint/" vJson "application/json" vResp To iSuccess
    If (iSuccess = 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


End_Procedure

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "username": "testusername",
    "password": "testpassword",
    "alias": "Test Account",
    "app_id": "77494029089751836"
}'
https://api.plivo.com/v1/Account/<auth_id>/Endpoint/

Postman Collection Item JSON

{
  "name": "Create an endpoint",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"username\": \"testusername\",\n    \"password\": \"testpassword\",\n    \"alias\": \"Test Account\",\n    \"app_id\": \"77494029089751836\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Endpoint/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Endpoint",
        ""
      ]
    },
    "description": "Creates a new endpoint.\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/voice/api/endpoint#create-an-endpoint)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| username      | Username for the endpoint to be created. Only alphanumeric characters are accepted. This username will be used to configure your SIP Phone. The username must start with an alphabet.| Required  |\n| password   | Password for your endpoint username. It should be at least 5 characters long.| Required      |\n| alias   | Alias for the endpoint. | Required |\n| app_id   | app_id of the application that will be attached to this endpoint. | Optional |"
  },
  "response": [
    {
      "name": "Create an endpoint",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"username\": \"testusername\",\n    \"password\": \"testpassword\",\n    \"alias\": \"Test Account\",\n    \"app_id\": \"77494029089751836\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Endpoint/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Endpoint",
            ""
          ]
        }
      },
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"username\": \"zumba131031145958\",\n    \"alias\": \"zumba\",\n    \"message\": \"created\",\n    \"endpoint_id\": \"37371860103666\",\n    \"api_id\": \"1c13de4c-423d-11e3-9899-22000abfa5d5\"\n}"
    }
  ]
}