Number Management Webhooks

OpenAPI Version: 3.1.1
API Version: 1.0.0

The Number Management webhooks allow developers to receive events for Number Management features.

Servers

URL: https://{your-endpoint-url}

Operations

number_management.peering_number_emergency_address_updated

Method: POST
Path: number_management.peering_number_emergency_address_updated
Tags: Cloud Peering Provider Exchange

The Emergency address has changed event triggers when the emergency addresses associated with PSTN phone numbers have been updated.

Prerequisites

Enable Number Management
Event subscriptions must be enabled for your Marketplace app with the following configurations:
- A valid Event notification endpoint URL.
- Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see Enable webhooks.
- Emergency address has changed subscription must be enabled under the Number Management event.

This event is for partners who have completed the MoU to peer with Zoom. To become a peering provider or carrier, submit your request.

Request Body

Content-Type: application/json

event (required)
string — The name of the event.
event_ts (required)
integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.
payload (required)
object
- account_id (required)
  string — The account ID of the customer using provider exchange.
- object (required)
  object
  carrier_code (required)
  integer, format: int32 — The carrier code.
  phone_numbers (required)
  array — The phone numbers ([E.164](https://en.wikipedia.org/wiki/E.164) format) with emergency address updates.
  emergency_address
  object — The emergency address info.
  address_line1 (required)
  string — The emergency address(house number and street name).
  address_line2
  string — The additional emergency address information (building, floor or unit number).
  city
  string — The city.
  country
  string — The abbreviated [country ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) of country.
  state_code
  string — The abbreviated [state code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#states-1) of the state.
  zip
  string — The zip code.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "emergency_address": {
        "country": "",
        "address_line1": "",
        "address_line2": "",
        "city": "",
        "zip": "",
        "state_code": ""
      },
      "carrier_code": 1,
      "phone_numbers": []
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

number_management.peering_number_cnam_updated

Method: POST
Path: number_management.peering_number_cnam_updated
Tags: Cloud Peering Provider Exchange

The CNAM has changed event triggers when the Caller ID name (CNAM) has been updated for PSTN phone numbers.

Prerequisites

Enable Number Management
Event subscriptions must be enabled for your Marketplace app with the following configurations:
- A valid Event notification endpoint URL.
- Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see Enable webhooks.
- CNAM has changed subscription must be enabled under the Number Management event.

This event is for partners who have completed the MoU to peer with Zoom. To become a peering provider or carrier, submit your request.

Request Body

Content-Type: application/json

event (required)
string — The name of the event.
event_ts (required)
integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.
payload (required)
object
- account_id (required)
  string — The account ID of the customer using provider exchange.
- object (required)
  object
  carrier_code (required)
  integer, format: int32 — The carrier code.
  phone_numbers (required)
  array — The phone numbers ([E.164](https://en.wikipedia.org/wiki/E.164) format) with CNAM updates.
  cnam
  string — The caller ID name.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "cnam": "",
      "carrier_code": 1,
      "phone_numbers": []
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

Schemas

Number_management.peering_number_emergency_address_updatedEvent

Type:object

event (required)
string — The name of the event.
event_ts (required)
integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.
payload (required)
object
- account_id (required)
  string — The account ID of the customer using provider exchange.
- object (required)
  object
  carrier_code (required)
  integer, format: int32 — The carrier code.
  phone_numbers (required)
  array — The phone numbers ([E.164](https://en.wikipedia.org/wiki/E.164) format) with emergency address updates.
  emergency_address
  object — The emergency address info.
  address_line1 (required)
  string — The emergency address(house number and street name).
  address_line2
  string — The additional emergency address information (building, floor or unit number).
  city
  string — The city.
  country
  string — The abbreviated [country ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) of country.
  state_code
  string — The abbreviated [state code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#states-1) of the state.
  zip
  string — The zip code.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "emergency_address": {
        "country": "",
        "address_line1": "",
        "address_line2": "",
        "city": "",
        "zip": "",
        "state_code": ""
      },
      "carrier_code": 1,
      "phone_numbers": []
    }
  }
}

Number_management.peering_number_cnam_updatedEvent

Type:object

event (required)
string — The name of the event.
event_ts (required)
integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.
payload (required)
object
- account_id (required)
  string — The account ID of the customer using provider exchange.
- object (required)
  object
  carrier_code (required)
  integer, format: int32 — The carrier code.
  phone_numbers (required)
  array — The phone numbers ([E.164](https://en.wikipedia.org/wiki/E.164) format) with CNAM updates.
  cnam
  string — The caller ID name.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "cnam": "",
      "carrier_code": 1,
      "phone_numbers": []
    }
  }
}