Suggestion to fix Webhook documentation on VoiceMail Received webhook

[pete_h (Pete Helgren)]

Check this post where the OP gets confirmation that the behavior has changed:

Zoom phone 'phone.voicemail_received' event unexpectedly changed structure

We started getting surprise errors in our application on April 9th regarding voicemails. It seems like the structure of the event has changed unexpectedly. Specifically, the callee_user_id field has been renamed to just callee_id in the phone.voicemail_received webhook event. Were there any release notes or notification channels we could have used to be aware of this upcoming change? There isn’t any mention of it in any of the changelogs.

The next step for your documentation team would be to add that tidbit to the documentation. Even the explanation of the behavior from the Staff person wasn’t completely accurate. He said this:

"In instances where the voicemail is left to the AutoReceptionist, CallQueue, or SharedLineGroup, the callee_user_id will be empty . Regarding callee_id this field is used (along with callee_extension_type) to identify the voicemail owner’s information. E.g.:

"callee_extension_type":"string" //user, callQueue, autoReceptionist, shareLineGroup

"callee_id":"string" //user: user_id(= callee_user_id); callQueue: group_id; autoReceptionist: auto_receptionist_id; shareLineGroup: share_line_group_id"

What I have seen is that the callee_user_id isn’t just empty, it’s completely missing from the json in the payload. Adding that detail would prevent the occasional failures I was seeing in the webhook calls.

Thanks

[will.zoom (Will)]

Hi @pete_h,

Thank you for this feedback, and for pointing that out. I will request our documentation team to make this clearer in our docs.

Many thanks for the diligence in following up on this topic.

-Will