API documentation does not match webhook payload - recording_completed

API and Webhooks
1

During testing of our Zoom Contact Centre integration, we found that the contact_center.recording_completed does not include the “users” and “consumers” arrays in the webhook payload. These fields are shown in the API webhook documentation (Contact Center Webhooks).

Is this a bug?

2

Hi @brad.close ,

I will follow up with docs. Can you please share a screenshot of what you’re seeing (with sensitive info obscured) please?

4

Hi @gianni.zoom. Thanks for the response.

Apologies for the slow reply; was waiting for the information to come back from the Developer. Here is a sample of the webhook payload we received (this is using a test set up, so I don’t know if it should be anonymised):

{
  "event" => "contact_center.recording_completed",
  "event_ts" => 1710723292512,
  "payload" => %{
    "account_id" => "TlpxuG1XQZyVpmdu3FCCNA",
    "object" => %{
      "channel" => "video",
      "channel_id" => "71z6Yr5oQwKTJarw+t3cEw==",
      "channel_type" => "video",
      "engagement_direction" => "inbound",
      "engagement_id" => "oRgjH2FJRqqErjTim6Uwug",
      "flow_id" => "lS7oQfRzTbq1dFzraKEb4w",
      "flow_name" => "IncomingVideo",
      "owner_id" => "ZWQ1659F6C6008337132175012A1E5C3620",
      "owner_name" => "Video",
      "owner_type" => "queue",
      "recording_duration" => 36,
      "recording_end_time" => "2024-03-18T00:54:52Z",
      "recording_id" => "QwhfHPSmTU24Wm-NYbJxJw",
      "recording_start_time" => "2024-03-18T00:50:50Z",
      "recording_type" => "automatic"
    }
  }
}

And this is the “List Engagement Recordings” response:

"recordings" : [
  %{
    "channel" => "video",
    "channel_type" => "video",
    "consumer_name" => "Customer",
    "consumer_number" => "",
    "consumers" => [%{"consumer_name" => "Customer", "consumer_number" => ""}],
    "direction" => "inbound",
    "display_name" => "<Display name>",
    "download_url" => "https://www.zoom.us/v2/contact_center/recording/download/QwhfHPSmTU24Wm-NYbJxJw?type=video",
    "engagement_id" => "oRgjH2FJRqqErjTim6Uwug",
    "flow_id" => "lS7oQfRzTbq1dFzraKEb4w",
    "flow_name" => "IncomingVideo",
    "owner_id" => "ZWQ1659F6C6008337132175012A1E5C3620",
    "owner_name" => "Video",
    "owner_type" => "queue",
    "playback_url" => "https://www.zoom.us/v2/contact_center/recording/playback/QwhfHPSmTU24Wm-NYbJxJw?type=video",
    "queue_id" => "ZWQ1659F6C6008337132175012A1E5C3620",
    "queue_name" => "Video",
    "recording_duration" => 36,
    "recording_end_time" => "2024-03-18T00:51:26Z",
    "recording_id" => "QwhfHPSmTU24Wm-NYbJxJw",
    "recording_start_time" => "2024-03-18T00:50:50Z",
    "recording_type" => "automatic",
    "transcript_url" => "https://www.zoom.us/v2/contact_center/recording/transcripts/download/QwhfHPSmTU24Wm-NYbJxJw?type=video",
    "user_email" => "<user_email>",
    "user_id" => "oP4byOOkQx2_G8j_hB0RzA"
  }
]

Please advise if this is as expected.

5

Hi @brad.close ,

This is okay if it’s a test account. I have submitted this for review with our API team (ZSEE-122842)

6

Hi @brad.close ,

Our team has discovered this is a bug and the ETA for the deployed fix is April 25 (ZOOM-691432).

7

This topic was automatically closed 24 hours after the last reply. New replies are no longer allowed.