Chilkat Online Tools

Swift / Zoom API / Update account's TSP information

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    let req = CkoHttpRequest()
    req.HttpVerb = "PATCH"
    req.Path = "/v2/tsp"
    req.ContentType = "multipart/form-data"
    req.AddParam("tsp_provider", value: "Excepteur Duis")

    req.AddParam("enable", value: "Excepteur Duisfalse")

    req.AddParam("tsp_enabled", value: "Excepteur Duisfalsefalse")

    req.AddParam("master_account_setting_extended", value: "Excepteur Duisfalsefalsetrue")

    req.AddParam("modify_credential_forbidden", value: "Excepteur Duisfalsefalsetruefalse")

    req.AddParam("dial_in_number_unrestricted", value: "Excepteur Duisfalsefalsetruefalsefalse")

    req.AddParam("tsp_bridge", value: "Excepteur DuisfalsefalsetruefalsefalseUS_TSP_TB")

    req.AddHeader("Authorization", value: "Bearer <access_token>")

    var resp: CkoHttpResponse? = http.SynchronousRequest("api.zoom.us", port: 443, ssl: true, req: req)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode != 204 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Response Body:")
        print("\(resp!.BodyStr)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil
    print("Success.")

}

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