Chilkat Online Tools

Objective-C / Zoom API / Delete SIP phone

Back to Collection Items

#import <CkoHttp.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";

CkoHttpResponse *resp = [http QuickRequest: @"DELETE" url: @"https://api.zoom.us/v2/sip_phones/:phoneId"];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

Curl Command

curl -X DELETE
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/sip_phones/:phoneId

Postman Collection Item JSON

{
  "name": "Delete SIP phone",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "DELETE",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/sip_phones/:phoneId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "sip_phones",
        ":phoneId"
      ],
      "variable": [
        {
          "key": "phoneId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) Unique Identifier of the SIP Phone. It can be retrieved from the List SIP Phones API."
        }
      ]
    },
    "description": "Use this API to delete a Zoom account's SIP phone. \n\n **Scopes:** `sip_phone:write:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \n\n**Prerequisites**: \n* Currently only supported on Cisco and Avaya PBX systems. \n* The user must enable **SIP Phone Integration** by contacting the [Zoom Sales](https://zoom.us/contactsales) team."
  },
  "response": [
    {
      "name": "**Error Code:** `200`<br>Permission missing: Enable SIP Phone Integration by contacting a Zoom Admin first.",
      "originalRequest": {
        "method": "DELETE",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/sip_phones/:phoneId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "sip_phones",
            ":phoneId"
          ],
          "variable": [
            {
              "key": "phoneId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique Identifier of the SIP Phone. It can be retrieved from the List SIP Phones API."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `204`<br>\nSIP Phone deleted.",
      "originalRequest": {
        "method": "DELETE",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/sip_phones/:phoneId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "sip_phones",
            ":phoneId"
          ],
          "variable": [
            {
              "key": "phoneId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique Identifier of the SIP Phone. It can be retrieved from the List SIP Phones API."
            }
          ]
        }
      },
      "status": "No Content",
      "code": 204,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{}"
    },
    {
      "name": "**Error Code:** `300`The SIP phone with this phoneId was not found on this account.",
      "originalRequest": {
        "method": "DELETE",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/sip_phones/:phoneId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "sip_phones",
            ":phoneId"
          ],
          "variable": [
            {
              "key": "phoneId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique Identifier of the SIP Phone. It can be retrieved from the List SIP Phones API."
            }
          ]
        }
      },
      "status": "Multiple Choices",
      "code": 300,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}