Chilkat Online Tools

SQL Server / Plivo REST API / Create an endpoint

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    EXEC sp_OASetProperty @http, 'BasicAuth', 1
    EXEC sp_OASetProperty @http, 'Login', '{{auth_id}}'
    EXEC sp_OASetProperty @http, 'Password', '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"
    -- }

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'username', 'testusername'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'password', 'testpassword'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'alias', 'Test Account'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'app_id', '77494029089751836'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://api.plivo.com/v1/Account/<auth_id>/Endpoint/', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

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}"
    }
  ]
}