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_code | Name | Event |
|---|---|---|
| 3000 | CALL_INFO_UPDATED | The participants in the call changed. |
| 3001 | CALL_HOLD | The user who started RTMS put the call on hold. |
| 3002 | CALL_RESUME | The user who started RTMS resumed the call from hold. |
| 3003 | TRANSFER_COMPLETED | A 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
}
}
| Field | Type | Description |
|---|---|---|
host_channel_id | string | The channel ID of the user who started RTMS. |
participants | array | The participants in the call. |
participants[].name | string | The display name, pstn, or a speaker label such as speaker1. |
participants[].phone_number/extension_number | string | The PSTN phone number or extension number of the participant. |
participants[].channel_id | string | The channel ID you use to find the audio for this participant. |
timestamp | unsigned long | The 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
}
}
| Field | Type | Description |
|---|---|---|
msg_type | string | The message type. For call events, this is "EVENT_UPDATE". |
event | object | Information about the call hold event. |
event_code | int | The call hold event code, 3001. For more information, see RTMS_EVENT_CODE. |
timestamp | unsigned long | The 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
}
}
| Field | Type | Description |
|---|---|---|
msg_type | string | The message type. For call events, this is "EVENT_UPDATE". |
event | object | Information about the call resume event. |
event_code | int | The call resume event code, 3002. For more information, see RTMS_EVENT_CODE. |
timestamp | unsigned long | The 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
}
}
| Field | Type | Description |
|---|---|---|
transfer_type | string | The type of transfer: MEETING, EXTENSION, or PSTN. |
transfer_result | object | The result of the transfer. |
meeting_uuid | string | The meeting UUID, when the call was upgraded to a meeting. |
extension_number | string | The extension number, when the call was transferred to an extension. |
phone_number | string | The phone number, when the call was transferred to a PSTN number. |