Chilkat Online Tools

SQL Server / Zoom API / Update account's TSP information

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

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

    EXEC sp_OASetProperty @req, 'HttpVerb', 'PATCH'
    EXEC sp_OASetProperty @req, 'Path', '/v2/tsp'
    EXEC sp_OASetProperty @req, 'ContentType', 'multipart/form-data'
    EXEC sp_OAMethod @req, 'AddParam', NULL, 'tsp_provider', 'Excepteur Duis'

    EXEC sp_OAMethod @req, 'AddParam', NULL, 'enable', 'Excepteur Duisfalse'

    EXEC sp_OAMethod @req, 'AddParam', NULL, 'tsp_enabled', 'Excepteur Duisfalsefalse'

    EXEC sp_OAMethod @req, 'AddParam', NULL, 'master_account_setting_extended', 'Excepteur Duisfalsefalsetrue'

    EXEC sp_OAMethod @req, 'AddParam', NULL, 'modify_credential_forbidden', 'Excepteur Duisfalsefalsetruefalse'

    EXEC sp_OAMethod @req, 'AddParam', NULL, 'dial_in_number_unrestricted', 'Excepteur Duisfalsefalsetruefalsefalse'

    EXEC sp_OAMethod @req, 'AddParam', NULL, 'tsp_bridge', 'Excepteur DuisfalsefalsetruefalsefalseUS_TSP_TB'

    EXEC sp_OAMethod @req, 'AddHeader', NULL, 'Authorization', 'Bearer <access_token>'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'SynchronousRequest', @resp OUT, 'api.zoom.us', 443, 1, @req
    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 @req
        RETURN
      END

    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode <> 204
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Response Body:'
        EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @resp

        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @req
        RETURN
      END
    EXEC @hr = sp_OADestroy @resp


    PRINT 'Success.'

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @req


END
GO

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	--form 'tsp_provider=Excepteur Duis'
	--form 'enable=Excepteur Duisfalse'
	--form 'tsp_enabled=Excepteur Duisfalsefalse'
	--form 'master_account_setting_extended=Excepteur Duisfalsefalsetrue'
	--form 'modify_credential_forbidden=Excepteur Duisfalsefalsetruefalse'
	--form 'dial_in_number_unrestricted=Excepteur Duisfalsefalsetruefalsefalse'
	--form 'tsp_bridge=Excepteur DuisfalsefalsetruefalsefalseUS_TSP_TB'
https://api.zoom.us/v2/tsp

Postman Collection Item JSON

{
  "name": "Update account's TSP information",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "tsp_provider",
          "value": "Excepteur Duis",
          "description": "3rd party audio conferencing provider",
          "type": "text"
        },
        {
          "key": "enable",
          "value": "false",
          "description": "Enable 3rd party audio conferencing for account users",
          "type": "text"
        },
        {
          "key": "tsp_enabled",
          "value": "false",
          "description": "Enable TSP feature for account. This has to be enabled to use any other tsp settings/features.",
          "type": "text"
        },
        {
          "key": "master_account_setting_extended",
          "value": "true",
          "description": "For master account, extend its TSP setting to all sub accounts. For sub account, extend TSP setting from master account.",
          "type": "text"
        },
        {
          "key": "modify_credential_forbidden",
          "value": "false",
          "description": "Control restriction on account users being able to modify their TSP credentials.",
          "type": "text"
        },
        {
          "key": "dial_in_number_unrestricted",
          "value": "false",
          "description": "Control restriction on account users adding a TSP number outside of account's dial in numbers.",
          "type": "text"
        },
        {
          "key": "tsp_bridge",
          "value": "US_TSP_TB",
          "description": "Telephony bridge (This can only be one of US_TSP_TB,EU_TSP_TB)",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/tsp",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "tsp"
      ]
    },
    "description": "Update information of the Telephony Service Provider set up on an account.<br>\n**Prerequisites**:<br>\nTSP account option should be enabled.<br>\n**Scopes:** `tsp:write:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\n"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `204` **No Content**<br>\nTSP Account updated.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "tsp_provider",
              "value": "Excepteur Duis",
              "description": "3rd party audio conferencing provider",
              "type": "text"
            },
            {
              "key": "enable",
              "value": "false",
              "description": "Enable 3rd party audio conferencing for account users",
              "type": "text"
            },
            {
              "key": "tsp_enabled",
              "value": "false",
              "description": "Enable TSP feature for account. This has to be enabled to use any other tsp settings/features.",
              "type": "text"
            },
            {
              "key": "master_account_setting_extended",
              "value": "true",
              "description": "For master account, extend its TSP setting to all sub accounts. For sub account, extend TSP setting from master account.",
              "type": "text"
            },
            {
              "key": "modify_credential_forbidden",
              "value": "false",
              "description": "Control restriction on account users being able to modify their TSP credentials.",
              "type": "text"
            },
            {
              "key": "dial_in_number_unrestricted",
              "value": "false",
              "description": "Control restriction on account users adding a TSP number outside of account's dial in numbers.",
              "type": "text"
            },
            {
              "key": "tsp_bridge",
              "value": "US_TSP_TB",
              "description": "Telephony bridge (This can only be one of US_TSP_TB,EU_TSP_TB)",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/tsp",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "tsp"
          ]
        }
      },
      "status": "No Content",
      "code": 204,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `400`<br>\nBad request.<br>\n\n**Error Code:** `300`<br>\nInvalid parameter: tsp_bridge.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "tsp_provider",
              "value": "Excepteur Duis",
              "description": "3rd party audio conferencing provider",
              "type": "text"
            },
            {
              "key": "enable",
              "value": "false",
              "description": "Enable 3rd party audio conferencing for account users",
              "type": "text"
            },
            {
              "key": "tsp_enabled",
              "value": "false",
              "description": "Enable TSP feature for account. This has to be enabled to use any other tsp settings/features.",
              "type": "text"
            },
            {
              "key": "master_account_setting_extended",
              "value": "true",
              "description": "For master account, extend its TSP setting to all sub accounts. For sub account, extend TSP setting from master account.",
              "type": "text"
            },
            {
              "key": "modify_credential_forbidden",
              "value": "false",
              "description": "Control restriction on account users being able to modify their TSP credentials.",
              "type": "text"
            },
            {
              "key": "dial_in_number_unrestricted",
              "value": "false",
              "description": "Control restriction on account users adding a TSP number outside of account's dial in numbers.",
              "type": "text"
            },
            {
              "key": "tsp_bridge",
              "value": "US_TSP_TB",
              "description": "Telephony bridge (This can only be one of US_TSP_TB,EU_TSP_TB)",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/tsp",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "tsp"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}