Zoom Phone events

View as Markdown

Zoom Phone events report call changes, such as holds, resumes, and transfers, while an RTMS stream is active.

Event codes

During a stream, the RTMS server sends call events to your app over the stream connection. Each event uses msg_type "EVENT_UPDATE", and each one has an event_code and a timestamp. The following table lists the event code and name for each event.

event_codeNameEvent
3000CALL_INFO_UPDATEDThe participants in the call changed.
3001CALL_HOLDThe user who started RTMS put the call on hold.
3002CALL_RESUMEThe user who started RTMS resumed the call from hold.
3003TRANSFER_COMPLETEDA transfer of the user who started RTMS completed.

Call info updated

The RTMS server sends this event when a participant joins or leaves the call. It contains the metadata for everyone in the call.

{
    "msg_type": "EVENT_UPDATE",
    "event": {
        "event_code": 3000,
        "host_channel_id": "channel_id",
        "participants": [
            {
                "name": "Bob",
                "phone_number/extension_number": "xxxxxxx",
                "channel_id": "xxx"
            },
            {
                "name": "Alice",
                "phone_number/extension_number": "xxxxx",
                "channel_id": "xxx"
            }
        ],
        "timestamp": 1727384349123
    }
}
FieldTypeDescription
host_channel_idstringThe channel ID of the user who started RTMS.
participantsarrayThe participants in the call.
participants[].namestringThe display name, pstn, or a speaker label such as speaker1.
participants[].phone_number/extension_numberstringThe PSTN phone number or extension number of the participant.
participants[].channel_idstringThe channel ID you use to find the audio for this participant.
timestampunsigned longThe Unix timestamp (milliseconds) when the event occurred.

Call hold

The RTMS server sends this event when the user who started RTMS puts the call on hold.

{
    "msg_type": "EVENT_UPDATE",
    "event": {
        "event_code": 3001,
        "timestamp": 1727384349123
    }
}
FieldTypeDescription
msg_typestringThe message type. For call events, this is "EVENT_UPDATE".
eventobjectInformation about the call hold event.
event_codeintThe call hold event code, 3001. For more information, see RTMS_EVENT_CODE.
timestampunsigned longThe Unix timestamp (milliseconds) when the user put the call on hold.

Call resume

The RTMS server sends this event when the user who started RTMS resumes the call from hold.

{
    "msg_type": "EVENT_UPDATE",
    "event": {
        "event_code": 3002,
        "timestamp": 1727384349123
    }
}
FieldTypeDescription
msg_typestringThe message type. For call events, this is "EVENT_UPDATE".
eventobjectInformation about the call resume event.
event_codeintThe call resume event code, 3002. For more information, see RTMS_EVENT_CODE.
timestampunsigned longThe Unix timestamp (milliseconds) when the user resumed the call.

Transfer completed

The RTMS server sends this event when a transfer of the user who started RTMS completes. There are three transfer types: upgrade to meeting, transfer to extension, and transfer to PSTN.

{
    "msg_type": "EVENT_UPDATE",
    "event": {
        "event_code": 3003,
        "transfer_type": "MEETING",
        "transfer_result": {
            "meeting_uuid": "xxxxxxxxxx"
        },
        "timestamp": 1727384349123
    }
}
FieldTypeDescription
transfer_typestringThe type of transfer: MEETING, EXTENSION, or PSTN.
transfer_resultobjectThe result of the transfer.
meeting_uuidstringThe meeting UUID, when the call was upgraded to a meeting.
extension_numberstringThe extension number, when the call was transferred to an extension.
phone_numberstringThe phone number, when the call was transferred to a PSTN number.