{"openapi":"3.0.0","info":{"title":"Number Management Webhooks","description":"The Number Management webhooks allow developers to receive events for Number Management features.","version":"1.0.0"},"paths":{"number_management.peering_number_emergency_address_updated":{"post":{"tags":["Cloud Peering Provider Exchange"],"summary":"number_management.peering_number_emergency_address_updated","description":"---\n\nThe **Emergency address has changed** event triggers when the emergency addresses associated with PSTN phone numbers have been updated. \n\n## Prerequisites\n* [Enable Number Management](https://zoom.us/cpw/page/phoneNumbers#/number-list)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Emergency address has changed** subscription must be enabled under the **Number Management** event.\n\n> This event is for partners who have completed the MoU to peer with Zoom. To become a peering provider or carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform).\n\n\n\n\n","operationId":"Number_management.peering_number_emergency_address_updatedWebhook","requestBody":{"description":"Webhook payload for the `number_management.peering_number_emergency_address_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Number_management.peering_number_emergency_address_updatedEvent"},"examples":{"default":{"summary":"Example number_management.peering_number_emergency_address_updated event","value":{"event":"number_management.peering_number_emergency_address_updated","event_ts":1619155436400,"payload":{"account_id":"Mt6sv4u0TAyPkwgsL2lxiA","object":{"emergency_address":{"address_line1":"55 ALMADEN BLVD","address_line2":"13F","city":"SAN JOSE","country":"US","state_code":"CA","zip":"95113"},"carrier_code":3457,"phone_numbers":["+18008001000"]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"number_management.peering_number_cnam_updated":{"post":{"tags":["Cloud Peering Provider Exchange"],"summary":"number_management.peering_number_cnam_updated","description":"---\n\nThe **CNAM has changed** event triggers when the Caller ID name (CNAM) has been updated for PSTN phone numbers. \n\n## Prerequisites\n* [Enable Number Management](https://zoom.us/cpw/page/phoneNumbers#/number-list)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **CNAM has changed** subscription must be enabled under the **Number Management** event.\n\n> This event is for partners who have completed the MoU to peer with Zoom. To become a peering provider or carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform). \n\n\n\n\n","operationId":"Number_management.peering_number_cnam_updatedWebhook","requestBody":{"description":"Webhook payload for the `number_management.peering_number_cnam_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Number_management.peering_number_cnam_updatedEvent"},"examples":{"default":{"summary":"Example number_management.peering_number_cnam_updated event","value":{"event":"number_management.peering_number_cnam_updated","event_ts":1619155436400,"payload":{"account_id":"Mt6sv4u0TAyPkwgsL2lxiA","object":{"cnam":"name","carrier_code":3457,"phone_numbers":["+18008001000"]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Number_management.peering_number_emergency_address_updatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the customer using provider exchange."},"object":{"required":["carrier_code","phone_numbers"],"type":"object","properties":{"emergency_address":{"required":["address_line1"],"type":"object","properties":{"country":{"type":"string","description":"The abbreviated [country ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) of country."},"address_line1":{"type":"string","description":"The emergency address(house number and street name)."},"address_line2":{"type":"string","description":"The additional emergency address information (building, floor or unit number). "},"city":{"type":"string","description":"The city."},"zip":{"type":"string","description":"The zip code."},"state_code":{"type":"string","description":"The abbreviated [state code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#states-1) of the state."}},"additionalProperties":false,"description":"The emergency address info."},"carrier_code":{"type":"integer","description":"The carrier code.","format":"int32"},"phone_numbers":{"type":"array","description":"The phone numbers ([E.164](https://en.wikipedia.org/wiki/E.164) format) with emergency address updates."}},"additionalProperties":false}},"additionalProperties":false}}},"Number_management.peering_number_cnam_updatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the customer using provider exchange."},"object":{"required":["carrier_code","phone_numbers"],"type":"object","properties":{"cnam":{"type":"string","description":"The caller ID name."},"carrier_code":{"type":"integer","description":"The carrier code.","format":"int32"},"phone_numbers":{"type":"array","description":"The phone numbers ([E.164](https://en.wikipedia.org/wiki/E.164) format) with CNAM updates."}},"additionalProperties":false}},"additionalProperties":false}}}}},"tags":[{"name":"Cloud Peering Provider Exchange"}],"servers":[{"url":"https://{your-endpoint-url}"}]}