Interested in seeing some example json output of some commands

API and Webhooks
1

Like many here, I’m working on some control libraries using this API, specifically using JSON. I currently DO NOT have access to equipment to test against (for now), so I’m doing my best to infer jObjects from the api.

Where my inferances fall apart would be whenever we get a response from a command that should return a list of items (participants, phonebooks, meetings, etc.) What would an example json response be for the commands

zCommand Call ListParticipants
zCommand Bookings List
zCommand Phonebook List

I’m not sure if these are going to return arrays of objects (great), or an object full of unique properties (much less great).

Any help is appreciated.

-Trevor

1 Like
2

I recommend installing a Zoom Room: having access to one is essential when
developing apps for the ZR-CSAPI. Here are the responses, for both CLI
and JSON:

format cli
zcommand bookings list
OK
*r BookingsListResult (status=OK):
*r BookingsListResult resultInfo TotalRows: 3
*r BookingsListResult Meeting 1 meetingName: Evening Mtg
*r BookingsListResult Meeting 1 meetingNumber: 186736193
*r BookingsListResult Meeting 1 hostName: 
*r BookingsListResult Meeting 1 startTime: 2019-02-10T20:00:00-08:00
*r BookingsListResult Meeting 1 endTime: 2019-02-10T20:30:00-08:00
*r BookingsListResult Meeting 1 creatorEmail: scottf@ginovia.com
*r BookingsListResult Meeting 1 creatorName: 
*r BookingsListResult Meeting 1 isPrivate: off
*r BookingsListResult Meeting 1 checkedIn: off
*r BookingsListResult Meeting 1 isInstantMeeting: off
*r BookingsListResult Meeting 1 calendarID: 7gd5p1e9agfceron8gfidehkfq
*r BookingsListResult Meeting 1 calendarChangeKey: 
*r BookingsListResult Meeting 1 accessRole: owner
*r BookingsListResult Meeting 1 location: HQ-1-N-DevRoom (5)
*r BookingsListResult Meeting 1 scheduledFrom: Calendar
*r BookingsListResult Meeting 1 thirdparty service_provider: -1
*r BookingsListResult Meeting 1 thirdparty meeting_number: 
*r BookingsListResult Meeting 1 thirdparty sip_address: 
*r BookingsListResult Meeting 1 thirdparty h323_address: 
*r BookingsListResult Meeting 2 meetingName: Second meeting
*r BookingsListResult Meeting 2 meetingNumber: 812529852
*r BookingsListResult Meeting 2 hostName: 
*r BookingsListResult Meeting 2 startTime: 2019-02-10T20:30:00-08:00
*r BookingsListResult Meeting 2 endTime: 2019-02-10T21:00:00-08:00
*r BookingsListResult Meeting 2 creatorEmail: scottf@ginovia.com
*r BookingsListResult Meeting 2 creatorName: 
*r BookingsListResult Meeting 2 isPrivate: off
*r BookingsListResult Meeting 2 checkedIn: off
*r BookingsListResult Meeting 2 isInstantMeeting: off
*r BookingsListResult Meeting 2 calendarID: 1r959tbsvah3dpl49kni1gq2vt
*r BookingsListResult Meeting 2 calendarChangeKey: 
*r BookingsListResult Meeting 2 accessRole: owner
*r BookingsListResult Meeting 2 location: HQ-1-N-DevRoom (5)
*r BookingsListResult Meeting 2 scheduledFrom: Calendar
*r BookingsListResult Meeting 2 thirdparty service_provider: -1
*r BookingsListResult Meeting 2 thirdparty meeting_number: 
*r BookingsListResult Meeting 2 thirdparty sip_address: 
*r BookingsListResult Meeting 2 thirdparty h323_address: 
*r BookingsListResult Meeting 3 meetingName: Late meeting
*r BookingsListResult Meeting 3 meetingNumber: 247750666
*r BookingsListResult Meeting 3 hostName: 
*r BookingsListResult Meeting 3 startTime: 2019-02-10T21:00:00-08:00
*r BookingsListResult Meeting 3 endTime: 2019-02-10T22:00:00-08:00
*r BookingsListResult Meeting 3 creatorEmail: scottf@ginovia.com
*r BookingsListResult Meeting 3 creatorName: 
*r BookingsListResult Meeting 3 isPrivate: off
*r BookingsListResult Meeting 3 checkedIn: off
*r BookingsListResult Meeting 3 isInstantMeeting: off
*r BookingsListResult Meeting 3 calendarID: 7cikmo1hfh9u7rqrg6curgnmgh
*r BookingsListResult Meeting 3 calendarChangeKey: 
*r BookingsListResult Meeting 3 accessRole: owner
*r BookingsListResult Meeting 3 location: HQ-1-N-DevRoom (5)
*r BookingsListResult Meeting 3 scheduledFrom: Calendar
*r BookingsListResult Meeting 3 thirdparty service_provider: -1
*r BookingsListResult Meeting 3 thirdparty meeting_number: 
*r BookingsListResult Meeting 3 thirdparty sip_address: 
*r BookingsListResult Meeting 3 thirdparty h323_address: 
** end

format json
zcommand bookings list
{
  "BookingsListResult": [
    {
      "accessRole": "owner",
      "calendarChangeKey": "",
      "calendarID": "7gd5p1e9agfceron8gfidehkfq",
      "checkIn": false,
      "creatorEmail": "scottf@ginovia.com",
      "creatorName": "",
      "endTime": "2019-02-10T20:30:00-08:00",
      "hostName": "",
      "isInstantMeeting": false,
      "isPrivate": false,
      "location": "HQ-1-N-DevRoom (5)",
      "meetingName": "Evening Mtg",
      "meetingNumber": "186736193",
      "scheduledFrom": "Calendar",
      "startTime": "2019-02-10T20:00:00-08:00",
      "third_party": {
        "h323_address": "",
        "meeting_number": "",
        "service_provider": "-1",
        "sip_address": ""
      }
    },
    {
      "accessRole": "owner",
      "calendarChangeKey": "",
      "calendarID": "1r959tbsvah3dpl49kni1gq2vt",
      "checkIn": false,
      "creatorEmail": "scottf@ginovia.com",
      "creatorName": "",
      "endTime": "2019-02-10T21:00:00-08:00",
      "hostName": "",
      "isInstantMeeting": false,
      "isPrivate": false,
      "location": "HQ-1-N-DevRoom (5)",
      "meetingName": "Second meeting",
      "meetingNumber": "812529852",
      "scheduledFrom": "Calendar",
      "startTime": "2019-02-10T20:30:00-08:00",
      "third_party": {
        "h323_address": "",
        "meeting_number": "",
        "service_provider": "-1",
        "sip_address": ""
      }
    },
    {
      "accessRole": "owner",
      "calendarChangeKey": "",
      "calendarID": "7cikmo1hfh9u7rqrg6curgnmgh",
      "checkIn": false,
      "creatorEmail": "scottf@ginovia.com",
      "creatorName": "",
      "endTime": "2019-02-10T22:00:00-08:00",
      "hostName": "",
      "isInstantMeeting": false,
      "isPrivate": false,
      "location": "HQ-1-N-DevRoom (5)",
      "meetingName": "Late meeting",
      "meetingNumber": "247750666",
      "scheduledFrom": "Calendar",
      "startTime": "2019-02-10T21:00:00-08:00",
      "third_party": {
        "h323_address": "",
        "meeting_number": "",
        "service_provider": "-1",
        "sip_address": ""
      }
    }
  ],
  "Status": {
    "message": "",
    "state": "OK"
  },
  "Sync": true,
  "topKey": "BookingsListResult",
  "type": "zEvent"
}

format cli
zcommand phonebook list offset: 0 limit:3
OK
*r PhonebookListResult (status=OK):
*r PhonebookListResult resultInfo Offset: 0
*r PhonebookListResult resultInfo Limit: 3
*r PhonebookListResult resultInfo TotalRows: 3
*r PhonebookListResult Contact 1 jid: tqr5lnhlsuglnjsecofq8w@xmpp.zoom.us
*r PhonebookListResult Contact 1 screenName:  Test2_with_space Last
*r PhonebookListResult Contact 1 firstName:  Test2_with_space
*r PhonebookListResult Contact 1 lastName: Last
*r PhonebookListResult Contact 1 phoneNumber: 
*r PhonebookListResult Contact 1 email: 
*r PhonebookListResult Contact 1 avatarURL: 
*r PhonebookListResult Contact 1 presence: PRESENCE_OFFLINE
*r PhonebookListResult Contact 1 onDesktop: off
*r PhonebookListResult Contact 1 onMobile: off
*r PhonebookListResult Contact 1 isZoomRoom: off
*r PhonebookListResult Contact 1 isLegacy: off
*r PhonebookListResult Contact 1 presence_status: 0
*r PhonebookListResult Contact 1 sip_phone_number: 
*r PhonebookListResult Contact 1 cloud_pbx_info isValid: on
*r PhonebookListResult Contact 1 cloud_pbx_info extension: 
*r PhonebookListResult Contact 1 cloud_pbx_info company_number: 
*r PhonebookListResult Contact 2 jid: 9mud06nirpe_sc922t3era@xmpp.zoom.us
*r PhonebookListResult Contact 2 screenName: !Test13 UserLast
*r PhonebookListResult Contact 2 firstName: !Test13
*r PhonebookListResult Contact 2 lastName: UserLast
*r PhonebookListResult Contact 2 phoneNumber: 
*r PhonebookListResult Contact 2 email: 
*r PhonebookListResult Contact 2 avatarURL: 
*r PhonebookListResult Contact 2 presence: PRESENCE_OFFLINE
*r PhonebookListResult Contact 2 onDesktop: off
*r PhonebookListResult Contact 2 onMobile: off
*r PhonebookListResult Contact 2 isZoomRoom: off
*r PhonebookListResult Contact 2 isLegacy: off
*r PhonebookListResult Contact 2 presence_status: 0
*r PhonebookListResult Contact 2 sip_phone_number: 
*r PhonebookListResult Contact 2 cloud_pbx_info isValid: on
*r PhonebookListResult Contact 2 cloud_pbx_info extension: 
*r PhonebookListResult Contact 2 cloud_pbx_info company_number: 
*r PhonebookListResult Contact 3 jid: zh0zpha7t4k4arylgfnymw@xmpp.zoom.us
*r PhonebookListResult Contact 3 screenName: #Test1 !Lastname
*r PhonebookListResult Contact 3 firstName: #Test1
*r PhonebookListResult Contact 3 lastName: !Lastname
*r PhonebookListResult Contact 3 phoneNumber: 
*r PhonebookListResult Contact 3 email: 
*r PhonebookListResult Contact 3 avatarURL: 
*r PhonebookListResult Contact 3 presence: PRESENCE_OFFLINE
*r PhonebookListResult Contact 3 onDesktop: off
*r PhonebookListResult Contact 3 onMobile: off
*r PhonebookListResult Contact 3 isZoomRoom: off
*r PhonebookListResult Contact 3 isLegacy: off
*r PhonebookListResult Contact 3 presence_status: 0
*r PhonebookListResult Contact 3 sip_phone_number: 
*r PhonebookListResult Contact 3 cloud_pbx_info isValid: on
*r PhonebookListResult Contact 3 cloud_pbx_info extension: 
*r PhonebookListResult Contact 3 cloud_pbx_info company_number: 
** end

format json
zcommand phonebook list offset: 0 limit:3
{
  "PhonebookListResult": {
    "Contacts": [
      {
        "avatarURL": "",
        "email": "",
        "firstName": " Test2_with_space",
        "isLegacy": false,
        "isZoomRoom": false,
        "jid": "tqr5lnhlsuglnjsecofq8w@xmpp.zoom.us",
        "lastName": "Last",
        "onDesktop": false,
        "onMobile": false,
        "phoneNumber": "",
        "presence": "PRESENCE_OFFLINE",
        "presence_status": 0,
        "screenName": " Test2_with_space Last",
        "sip_phone_number": ""
      },
      {
        "avatarURL": "",
        "email": "",
        "firstName": "!Test13",
        "isLegacy": false,
        "isZoomRoom": false,
        "jid": "9mud06nirpe_sc922t3era@xmpp.zoom.us",
        "lastName": "UserLast",
        "onDesktop": false,
        "onMobile": false,
        "phoneNumber": "",
        "presence": "PRESENCE_OFFLINE",
        "presence_status": 0,
        "screenName": "!Test13 UserLast",
        "sip_phone_number": ""
      },
      {
        "avatarURL": "",
        "email": "",
        "firstName": "#Test1",
        "isLegacy": false,
        "isZoomRoom": false,
        "jid": "zh0zpha7t4k4arylgfnymw@xmpp.zoom.us",
        "lastName": "!Lastname",
        "onDesktop": false,
        "onMobile": false,
        "phoneNumber": "",
        "presence": "PRESENCE_OFFLINE",
        "presence_status": 0,
        "screenName": "#Test1 !Lastname",
        "sip_phone_number": ""
      }
    ],
    "Limit": 3,
    "Offset": 0
  },
  "Status": {
    "message": "",
    "state": "OK"
  },
  "Sync": true,
  "topKey": "PhonebookListResult",
  "type": "zCommand"
}

zcommand call listparticipants
OK
*r ListParticipantsResult (status=OK):
*r ListParticipantsResult resultInfo TotalRows: 2
*r ListParticipantsResult 1 user_name: AlexMarmer1
*r ListParticipantsResult 1 user_id: 16778240
*r ListParticipantsResult 1 is_host: on
*r ListParticipantsResult 1 is_myself: on
*r ListParticipantsResult 1 can_record: off
*r ListParticipantsResult 1 is_recording: off
*r ListParticipantsResult 1 avatar_url: 
*r ListParticipantsResult 1 local_recording_disabled: on
*r ListParticipantsResult 1 is_video_can_mute_byHost: on
*r ListParticipantsResult 1 is_video_can_unmute_byHost: on
*r ListParticipantsResult 1 isCohost: off
*r ListParticipantsResult 1 user_type: NORMAL
*r ListParticipantsResult 1 audio_status type: AUDIO_VOIP
*r ListParticipantsResult 1 audio_status state: AUDIO_UNMUTED
*r ListParticipantsResult 1 video_status has_source: on
*r ListParticipantsResult 1 video_status is_sending: on
*r ListParticipantsResult 1 video_status is_receiving: off
*r ListParticipantsResult 1 camera_status can_i_request_control: off
*r ListParticipantsResult 1 camera_status am_i_controlling: off
*r ListParticipantsResult 1 camera_status can_switch_camera: off
*r ListParticipantsResult 1 camera_status can_move_camera: off
*r ListParticipantsResult 1 camera_status can_zoom_camera: off
*r ListParticipantsResult 1 is_client_support_closed_caption: off
*r ListParticipantsResult 1 can_edit_closed_caption: off
*r ListParticipantsResult 1 is_client_support_coHost: off
*r ListParticipantsResult 1 hand_status is_valid: off
*r ListParticipantsResult 1 event: None
*r ListParticipantsResult 2 user_name: Scott Firestone
*r ListParticipantsResult 2 user_id: 16779264
*r ListParticipantsResult 2 is_host: off
*r ListParticipantsResult 2 is_myself: off
*r ListParticipantsResult 2 can_record: off
*r ListParticipantsResult 2 is_recording: off
*r ListParticipantsResult 2 avatar_url: https://zoom.us/p/VflzRHh2QSu8M3KDTTsMKw/d5c33d51-22c6-4b35-aea3-8b3bb060c01f-4751
*r ListParticipantsResult 2 local_recording_disabled: off
*r ListParticipantsResult 2 is_video_can_mute_byHost: on
*r ListParticipantsResult 2 is_video_can_unmute_byHost: on
*r ListParticipantsResult 2 isCohost: off
*r ListParticipantsResult 2 user_type: NORMAL
*r ListParticipantsResult 2 audio_status type: AUDIO_VOIP
*r ListParticipantsResult 2 audio_status state: AUDIO_UNMUTED
*r ListParticipantsResult 2 video_status has_source: on
*r ListParticipantsResult 2 video_status is_sending: on
*r ListParticipantsResult 2 video_status is_receiving: on
*r ListParticipantsResult 2 camera_status can_i_request_control: off
*r ListParticipantsResult 2 camera_status am_i_controlling: off
*r ListParticipantsResult 2 camera_status can_switch_camera: on
*r ListParticipantsResult 2 camera_status can_move_camera: off
*r ListParticipantsResult 2 camera_status can_zoom_camera: off
*r ListParticipantsResult 2 is_client_support_closed_caption: off
*r ListParticipantsResult 2 can_edit_closed_caption: off
*r ListParticipantsResult 2 is_client_support_coHost: off
*r ListParticipantsResult 2 hand_status is_valid: off
*r ListParticipantsResult 2 event: None
** end

format json
zcommand call listparticipants
{
  "ListParticipantsResult": [
    {
      "audio_status state": "AUDIO_UNMUTED",
      "audio_status type": "AUDIO_VOIP",
      "avatar_url": "",
      "camera_status am_i_controlling": false,
      "camera_status can_i_request_control": false,
      "camera_status can_move_camera": false,
      "camera_status can_switch_camera": false,
      "camera_status can_zoom_camera": false,
      "can_edit_closed_caption": false,
      "can_record": false,
      "event": "None",
      "hand_status": {
        "is_valid: ": "off"
      },
      "isCohost": false,
      "is_client_support_closed_caption": false,
      "is_client_support_coHost": false,
      "is_host": true,
      "is_myself": true,
      "is_recording": false,
      "is_video_can_mute_byHost": true,
      "is_video_can_unmute_byHost": true,
      "local_recording_disabled": true,
      "user_id": 16778240,
      "user_name": "AlexMarmer1",
      "user_type": "NORMAL",
      "video_status has_source": true,
      "video_status is_receiving": false,
      "video_status is_sending": true
    },
    {
      "audio_status state": "AUDIO_UNMUTED",
      "audio_status type": "AUDIO_VOIP",
      "avatar_url": "https://zoom.us/p/VflzRHh2QSu8M3KDTTsMKw/d5c33d51-22c6-4b35-aea3-8b3bb060c01f-4751",
      "camera_status am_i_controlling": false,
      "camera_status can_i_request_control": false,
      "camera_status can_move_camera": false,
      "camera_status can_switch_camera": true,
      "camera_status can_zoom_camera": false,
      "can_edit_closed_caption": false,
      "can_record": false,
      "event": "None",
      "hand_status": {
        "is_valid: ": "off"
      },
      "isCohost": false,
      "is_client_support_closed_caption": false,
      "is_client_support_coHost": false,
      "is_host": false,
      "is_myself": false,
      "is_recording": false,
      "is_video_can_mute_byHost": true,
      "is_video_can_unmute_byHost": true,
      "local_recording_disabled": false,
      "user_id": 16779264,
      "user_name": "Scott Firestone",
      "user_type": "NORMAL",
      "video_status has_source": true,
      "video_status is_receiving": true,
      "video_status is_sending": true
    }
  ],
  "Status": {
    "message": "",
    "state": "OK"
  },
  "Sync": true,
  "topKey": "ListParticipantsResult",
  "type": "zCommand"
}