Zoom Phone Emergency Addresses API

openapi: 3.2.0
info:
  title: Phone Emergency Addresses API
  description: "You can access information from Zoom with Zoom Phone APIs to build private services or public applications on the [Zoom App Marketplace](https://marketplace.zoom.us/).\n\n  To learn how to get your credentials and create private or public applications, see Zoom APIs use [OAuth 2.0 authorization](https://developers.zoom.us/docs/integrations/oauth/). \n\n  All endpoints are available through `https` at `api.zoom.us/v2/`. For instance, `https://api.zoom.us/v2/users/` returns all users on an account. You'll receive a `403` error message if you have not set up Zoom Phone."
  termsOfService: https://zoom.us/docs/en-us/zoom_api_license_and_tou.html
  contact:
    name: Zoom Developers
    url: https://developer.zoom.us/
  version: '2'
servers:
- url: https://api.zoom.us/v2
tags:
- name: Emergency Addresses
paths:
  /phone/emergency_addresses:
    get:
      tags:
      - Emergency Addresses
      summary: List emergency addresses
      description: "Lists the emergency addresses.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_emergency_addresses:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
      operationId: listEmergencyAddresses
      parameters:
      - name: site_id
        in: query
        description: The emergency address site ID.
        required: false
        schema:
          type: string
          example: SQv52YtkRLC2dwrDdYtGsA
      - name: user_id
        in: query
        description: User ID to which the personal emergency address belongs.
        required: false
        schema:
          type: string
          example: DnEopNmXQEGU2uvvzjgojw
      - name: level
        in: query
        description: "The emergency address owner level:\n\n* `0` - Account/Company-level emergency address. \n\n* `1` - User/Personal-level emergency address.\n\n* `2` - Unknown company/pending emergency address."
        required: false
        schema:
          type: integer
          example: 1
          enum:
          - 0
          - 1
          - 2
      - name: status
        in: query
        description: "The emergency address verification status: \n* `1` — Verification not Required. \n* `2` — Unverified. \n* `3` — Verification requested. \n* `4` — Verified. \n* `5` — Rejected. \n* `6` — Verification failed."
        required: false
        schema:
          type: integer
          example: 1
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
      - name: address_keyword
        in: query
        description: "Keyword(s) to filter emergency addresses. You can filter by either: \n* Address Line 1. \n* Address Line 2. \n* City. \n* State Abbreviation. \n* Zip Code."
        required: false
        schema:
          type: string
          example: 55 ALMADEN BLVD
      - name: next_page_token
        in: query
        description: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
        required: false
        schema:
          type: string
          example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
      - name: page_size
        in: query
        description: The number of records returned within a single API call.
        required: false
        schema:
          maximum: 300
          type: integer
          example: 30
          default: 30
      responses:
        '200':
          description: '**HTTP Status Code:** `200`


            Emergency addresses listed successfully.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  emergency_addresses:
                    type: array
                    description: Information about emergency addresses.
                    items:
                      type: object
                      properties:
                        address_line1:
                          type: string
                          description: The emergency address line 1.
                          example: 55 ALMADEN BLVD
                        address_line2:
                          type: string
                          description: The emergency address line 2.
                          example: 8 Floor
                        city:
                          type: string
                          description: The emergency address city.
                          example: SAN JOSE
                        country:
                          type: string
                          description: The emergency address country.
                          example: US
                        id:
                          type: string
                          description: The emergency address ID.
                          example: Qza2T_KATwCeUfTkzGsOmQ
                        is_default:
                          type: boolean
                          description: Indicates whether the emergency address is default or not.
                          example: true
                        level:
                          type: integer
                          description: "The emergency address owner level:\n\n* `0` - Account/Company-level emergency address. \n\n* `1` - User/Personal-level emergency address.\n\n* `2` - Unknown company/pending emergency address."
                          example: 1
                          enum:
                          - 0
                          - 1
                          - 2
                        owner:
                          type: object
                          properties:
                            extension_number:
                              type: integer
                              description: The emergency address owner extension number.
                              format: int64
                              example: 101002
                            id:
                              type: string
                              description: The emergency address owner ID.
                              example: y9th648XRfSL9S61p1TsBw
                            name:
                              type: string
                              description: The emergency address owner name.
                              example: ZOOM_API Test
                          description: The emergency address owner information for a user-level emergency address.
                        site:
                          type: object
                          properties:
                            id:
                              type: string
                              description: The site's ID.
                              example: SQv52YtkRLC2dwrDdYtGsA
                            name:
                              type: string
                              description: The site's name.
                              example: Main site
                          description: The emergency address site information.
                        state_code:
                          type: string
                          description: The emergency address state code.
                          example: CA
                        status:
                          type: integer
                          description: "The emergency address verification status: \n* `1` — Verification not required. \n* `2` — Unverified. \n* `3` — Verification requested. \n* `4` — Verified. \n* `5` — Rejected. \n* `6` — Verification failed."
                          example: 1
                          enum:
                          - 1
                          - 2
                          - 3
                          - 4
                          - 5
                          - 6
                        zip:
                          type: string
                          description: The emergency address zip code.
                          example: '95113'
                  next_page_token:
                    type: string
                    description: The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
                    example: T6WMY4fJBIAlxPUiqRtwvQS9dvsq8AoRam2
                  page_size:
                    type: integer
                    description: The number of records returned with a single API call.
                    example: 30
                  total_records:
                    type: integer
                    description: The total number of records returned.
                    example: 20
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request\n\n**Error Code:** `400` <br>\nSite does not exist: {site_id}\n\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:read:admin
        - phone:read:list_emergency_addresses:admin
        openapi_authorization: []
      x-extensions:
        x-macro-scopes:
        - phone:read:admin
        x-granular-scopes:
        - phone:read:list_emergency_addresses:admin
    post:
      tags:
      - Emergency Addresses
      summary: Add an emergency address
      description: "Adds an emergency address. If the address provided is not an exact match, the system generated corrected address will be used. \n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:emergency_address:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
      operationId: addEmergencyAddress
      requestBody:
        content:
          application/json:
            schema:
              required:
              - address_line1
              - city
              - country
              - state_code
              - zip
              type: object
              properties:
                address_line1:
                  type: string
                  description: The emergency address line 1.
                  example: 55 Almaden Blvd
                address_line2:
                  type: string
                  description: The emergency address line 2.
                  example: 8 Floor
                city:
                  type: string
                  description: The emergency address city.
                  example: San Jose
                country:
                  type: string
                  description: The emergency address country.
                  example: US
                is_default:
                  type: boolean
                  description: Indicates whether the emergency address is default or not.
                  example: true
                site_id:
                  type: string
                  description: The site ID. Nullable if 'user_id' is not null.
                  example: SQv52YtkRLC2dwrDdYtGsA
                state_code:
                  type: string
                  description: The emergency address state code.
                  example: '10'
                user_id:
                  type: string
                  description: User ID to which the personal emergency address belongs.
                  example: fWOgOALdT1ei4vjXK-QYsA
                zip:
                  type: string
                  description: The emergency address zip code.
                  example: '95113'
      responses:
        '201':
          description: '**HTTP Status Code:** `201` **Created**


            Emergency address added successfully.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  address_line1:
                    type: string
                    description: The emergency address line 1.
                    example: 55 Almaden Blvd
                  address_line2:
                    type: string
                    description: The emergency address line 2.
                    example: 8 Floor
                  city:
                    type: string
                    description: The emergency address city.
                    example: San Jose
                  country:
                    type: string
                    description: The emergency address country.
                    example: US
                  id:
                    type: string
                    description: The emergency address ID.
                    example: Qza2T_KATwCeUfTkzGsOmQ
                  is_default:
                    type: boolean
                    description: Indicates whether the emergency address is default or not.
                    example: true
                  level:
                    type: integer
                    description: "The emergency address owner level:\n\n* `0` - Account/Company-level emergency address. \n\n* `1` - User/Personal-level emergency address.\n\n* `2` - Unknown company/pending emergency address."
                    example: 1
                    enum:
                    - 0
                    - 1
                    - 2
                  owner:
                    type: object
                    properties:
                      extension_number:
                        type: string
                        description: The emergency address owner extension number.
                        example: '101002'
                      id:
                        type: string
                        description: The emergency address owner ID.
                        example: y9th648XRfSL9S61p1TsBw
                      name:
                        type: string
                        description: The emergency address owner name.
                        example: ZOOM_API Test
                    description: The emergency address owner information for a user-level emergency address.
                  site:
                    type: object
                    properties:
                      id:
                        type: string
                        description: The site's ID.
                        example: SQv52YtkRLC2dwrDdYtGsA
                      name:
                        type: string
                        description: The site's name.
                        example: Main site
                    description: The emergency address site information.
                  state_code:
                    type: string
                    description: The emergency address state code.
                    example: CA
                  status:
                    type: integer
                    description: "The emergency address verification status: \n* `1` &mdash; Verification not required. \n* `2` &mdash; Unverified. \n* `3` &mdash; Verification requested. \n* `4` &mdash; Verified. \n* `5` &mdash; Rejected. \n* `6` &mdash; Verification failed."
                    example: 1
                    enum:
                    - 1
                    - 2
                    - 3
                    - 4
                    - 5
                    - 6
                  zip:
                    type: string
                    description: The emergency address zip code.
                    example: '95113'
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request\n\n**Error Code:** `300` <br>\n\n\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:write:admin
        - phone:write:emergency_address:admin
        openapi_authorization: []
      x-extensions:
        x-macro-scopes:
        - phone:write:admin
        x-granular-scopes:
        - phone:write:emergency_address:admin
  /phone/emergency_addresses/{emergencyAddressId}:
    get:
      tags:
      - Emergency Addresses
      summary: Get emergency address details
      description: "Gets the emergency address information.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions  \n \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:emergency_address:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
      operationId: getEmergencyAddress
      parameters:
      - name: emergencyAddressId
        in: path
        description: The emergency address ID.
        required: true
        schema:
          type: string
          example: Qza2T_KATwCeUfTkzGsOmQ
      responses:
        '200':
          description: '**HTTP Status Code:** `200` **OK**


            Emergency address retrieved successfully.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  address_line1:
                    type: string
                    description: The emergency address line 1.
                    example: 55 ALMADEN BLVD
                  address_line2:
                    type: string
                    description: The emergency address line 2.
                    example: 8 Floor
                  city:
                    type: string
                    description: The emergency address city.
                    example: San Jose
                  country:
                    type: string
                    description: The emergency address country.
                    example: US
                  id:
                    type: string
                    description: The emergency address ID.
                    example: Qza2T_KATwCeUfTkzGsOmQ
                  is_default:
                    type: boolean
                    description: Indicates whether the emergency address is default or not.
                    example: true
                  level:
                    type: integer
                    description: "The emergency address owner level:\n\n* `0` - Account/Company-level emergency address. \n\n* `1` - User/Personal-level emergency address.\n\n* `2` - Unknown company/pending emergency address."
                    example: 1
                    enum:
                    - 0
                    - 1
                    - 2
                  owner:
                    type: object
                    properties:
                      extension_number:
                        type: integer
                        description: The extension number of the emergency address owner .
                        format: int64
                        example: 101002
                      id:
                        type: string
                        description: The emergency address owner ID.
                        example: y9th648XRfSL9S61p1TsBw
                      name:
                        type: string
                        description: The emergency address owner name.
                        example: ZOOM_API Test
                    description: The emergency address owner information for a user-level emergency address.
                  site:
                    type: object
                    properties:
                      id:
                        type: string
                        description: The site's ID.
                        example: SQv52YtkRLC2dwrDdYtGsA
                      name:
                        type: string
                        description: The site's name.
                        example: Main site
                    description: The emergency address site information.
                  state_code:
                    type: string
                    description: The emergency address state code.
                    example: CA
                  status:
                    type: integer
                    description: "The emergency address verification status: \n* `1` &mdash; Verification not required. \n* `2` &mdash; Unverified. \n* `3` &mdash; Verification requested. \n* `4` &mdash; Verified. \n* `5` &mdash; Rejected. \n* `6` &mdash; Verification failed."
                    example: 1
                    enum:
                    - 1
                    - 2
                    - 3
                    - 4
                    - 5
                    - 6
                  zip:
                    type: string
                    description: The emergency address zip code.
                    example: '95113'
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request\n\n**Error Code:** `400` <br>\nEmergency address does not exist {emergencyAddressId}.\n\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:read:admin
        - phone:read:emergency_address:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:read:admin
        x-granular-scopes:
        - phone:read:emergency_address:admin
    delete:
      tags:
      - Emergency Addresses
      summary: Delete an emergency address
      description: "Removes an emergency address.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:emergency_address:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`"
      operationId: deleteEmergencyAddress
      parameters:
      - name: emergencyAddressId
        in: path
        description: The emergency address ID.
        required: true
        schema:
          type: string
          example: Qza2T_KATwCeUfTkzGsOmQ
      responses:
        '204':
          description: '**HTTP Status Code:** `204` **No Content**


            Emergency address deleted successfully.'
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request\n\n**Error Code:** `300` <br>\n\n\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:write:admin
        - phone:delete:emergency_address:admin
        openapi_authorization: []
      x-extensions:
        x-macro-scopes:
        - phone:write:admin
        x-granular-scopes:
        - phone:delete:emergency_address:admin
    patch:
      tags:
      - Emergency Addresses
      summary: Update an emergency address
      description: "Updates an emergency address information. If the address provided is not an exact match, the system generated corrected address will be used. \n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:emergency_address:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
      operationId: updateEmergencyAddress
      parameters:
      - name: emergencyAddressId
        in: path
        description: The ID of the emergency address.
        required: true
        schema:
          type: string
          example: Qza2T_KATwCeUfTkzGsOmQ
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                address_line1:
                  type: string
                  description: The emergency address line 1.
                  example: 55 Almaden Blvd
                address_line2:
                  type: string
                  description: The emergency address line 2.
                  example: 8 Floor
                city:
                  type: string
                  description: The emergency address city.
                  example: San Jose
                country:
                  type: string
                  description: The emergency address country.
                  example: US
                is_default:
                  type: boolean
                  description: Whether the emergency address is default or not.
                  example: false
                state_code:
                  type: string
                  description: The emergency address state code.
                  example: CA
                zip:
                  type: string
                  description: The emergency address zip code.
                  example: '95113'
      responses:
        '200':
          description: '**HTTP Status Code:** `200` **OK**


            Emergency address updated successfully.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  address_line1:
                    type: string
                    description: The emergency address line 1.
                    example: 55 ALMADEN BLVD
                  address_line2:
                    type: string
                    description: The emergency address line 2.
                    example: 8 Floor
                  city:
                    type: string
                    description: The emergency address city.
                    example: San Jose
                  country:
                    type: string
                    description: The emergency address country.
                    example: US
                  id:
                    type: string
                    description: The emergency address ID.
                    example: Qza2T_KATwCeUfTkzGsOmQ
                  is_default:
                    type: boolean
                    description: Whether the emergency address is default or not.
                    example: true
                  level:
                    type: integer
                    description: "The emergency address owner level:  \n \n* `0` - Account/Company-level emergency address.   \n \n* `1` - User/Personal-level emergency address.  \n \n* `2` - Unknown company/pending emergency address."
                    example: 1
                    enum:
                    - 0
                    - 1
                    - 2
                  owner:
                    type: object
                    properties:
                      extension_number:
                        type: integer
                        description: The extension number of the emergency address owner.
                        format: int64
                        example: 101002
                      id:
                        type: string
                        description: The ID of the emergency address owner.
                        example: y9th648XRfSL9S61p1TsBw
                      name:
                        type: string
                        description: The name of the emergency address owner.
                        example: ZOOM_API Test
                    description: The emergency address owner information for a user-level emergency address.
                  site:
                    type: object
                    properties:
                      id:
                        type: string
                        description: The site's ID.
                        example: SQv52YtkRLC2dwrDdYtGsA
                      name:
                        type: string
                        description: The site's name.
                        example: Main site
                    description: The information about the emergency address site.
                  state_code:
                    type: string
                    description: The emergency address state code.
                    example: CA
                  status:
                    type: integer
                    description: "The emergency address verification status: \n* `1` &mdash; Verification not required. \n* `2` &mdash; Unverified. \n* `3` &mdash; Verification requested. \n* `4` &mdash; Verified. \n* `5` &mdash; Rejected. \n* `6` &mdash; Verification failed."
                    example: 1
                    enum:
                    - 1
                    - 2
                    - 3
                    - 4
                    - 5
                    - 6
                  zip:
                    type: string
                    description: The emergency address zip code.
                    example: '95113'
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request\n\n**Error Code:** `300` <br>\n\n\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:write:admin
        - phone:update:emergency_address:admin
        openapi_authorization: []
      x-extensions:
        x-macro-scopes:
        - phone:write:admin
        x-granular-scopes:
        - phone:update:emergency_address:admin
components:
  securitySchemes:
    openapi_authorization:
      type: apiKey
      name: Authorization
      in: header
    openapi_oauth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /
          tokenUrl: ''
          refreshUrl: ''
          scopes:
            phone:read:admin: phone:read:admin
            phone:read:list_account_settings:admin: phone:read:list_account_settings:admin
            phone:write:admin: phone:write:admin
            phone:write:customized_number:admin: phone:write:customized_number:admin
            phone:read:list_customized_number:admin: phone:read:list_customized_number:admin
            phone:delete:customized_number:admin: phone:delete:customized_number:admin
            phone:write:alert_setting:admin: phone:write:alert_setting:admin
            phone:read:list_alert_settings:admin: phone:read:list_alert_settings:admin
            phone:read:alert_setting:admin: phone:read:alert_setting:admin
            phone:patch:alert_setting:admin: phone:patch:alert_setting:admin
            phone:delete:alert_setting:admin: phone:delete:alert_setting:admin
            phone:read: phone:read
            phone:read:audio: phone:read:audio
            phone:read:audio:admin: phone:read:audio:admin
            phone:write: phone:write
            phone:delete:audio: phone:delete:audio
            phone:delete:audio:admin: phone:delete:audio:admin
            phone:update:audio: phone:update:audio
            phone:update:audio:admin: phone:update:audio:admin
            phone:read:list_audios: phone:read:list_audios
            phone:read:list_audios:admin: phone:read:list_audios:admin
            phone:write:audio: phone:write:audio
            phone:write:audio:admin: phone:write:audio:admin
            phone:write:batch_audios: phone:write:batch_audios
            phone:write:batch_audios:admin: phone:write:batch_audios:admin
            phone:read:list_auto_receptionists:admin: phone:read:list_auto_receptionists:admin
            phone:write:auto_receptionist:admin: phone:write:auto_receptionist:admin
            phone:delete:auto_receptionis

# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoom-phone/refs/heads/main/openapi/zoom-phone-emergency-addresses-api-openapi.yml