VB.NET / Zoom API / Set global dial-in URL for a TSP user
Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
Dim req As New Chilkat.HttpRequest
req.HttpVerb = "PATCH"
req.Path = "/v2/users/:userId/tsp/settings"
req.ContentType = "multipart/form-data"
req.AddParam("audio_url","dolor quis")
req.AddHeader("Authorization","Bearer <access_token>")
Dim resp As Chilkat.HttpResponse = http.SynchronousRequest("api.zoom.us",443,True,req)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode <> 204) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Response Body:")
Debug.WriteLine(resp.BodyStr)
Debug.WriteLine("Failed.")
Exit Sub
End If
Debug.WriteLine("Success.")
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'audio_url=dolor quis'
https://api.zoom.us/v2/users/:userId/tsp/settings
Postman Collection Item JSON
{
"name": "Set global dial-in URL for a TSP user",
"request": {
"auth": {
"type": "oauth2"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "audio_url",
"value": "dolor quis",
"description": "The global dial-in URL for a TSP enabled account. The URL must be valid with a max-length of 512 characters.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/users/:userId/tsp/settings",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"tsp",
"settings"
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The userId or email address of the user."
}
]
},
"description": "A global dial-in page can provide a list of global access numbers using which audio conferencing can be conducted. By calling this API, you can set the url for the global dial-in page of a user whose Zoom account has TSP and special TSP with third-party audio conferencing options enabled. <p></p>\n**Scopes:**`tsp:write:admin` `tsp:write`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\n"
},
"response": [
{
"name": "**Status Code:** `204` **No Content** <br>\nURL set successfully.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "audio_url",
"value": "dolor quis",
"description": "The global dial-in URL for a TSP enabled account. The URL must be valid with a max-length of 512 characters.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/users/:userId/tsp/settings",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"tsp",
"settings"
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The userId or email address of the user."
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `400` **Bad Request** <br><br>\n**Error Code**: `2000`<br>\nNot TSP special account.<br>\n\nThs error means that the account does not have special TSP privilege. Contact Zoom Developer Support for details.<br>\n**Error Code**: `2024`<br>\n",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "audio_url",
"value": "dolor quis",
"description": "The global dial-in URL for a TSP enabled account. The URL must be valid with a max-length of 512 characters.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/users/:userId/tsp/settings",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"tsp",
"settings"
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The userId or email address of the user."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404`<br>\nUser ID not found.<br>\n**Error Code**: `1001`<br>\nUser {userId} not exist or not belong to this account.\n**Error Code**: `1120`<br>\nInvite not exist.\n\nThis error is thrown if you added a user in your account but the user di",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "audio_url",
"value": "dolor quis",
"description": "The global dial-in URL for a TSP enabled account. The URL must be valid with a max-length of 512 characters.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/users/:userId/tsp/settings",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"tsp",
"settings"
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The userId or email address of the user."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
