Get call quality of service(QoS) data for a call made or received by a Zoom phone user in the account.
Prerequisites:
- Business, or Education account
- Zoom Phone license
Scopes:phone:read:admin,phone:write:admin
Rate Limit Label:Light
643 matches
60 actions
Zoom
60 actions
Communication/Zoom
Get call quality of service(QoS) data for a call made or received by a Zoom phone user in the account.
Prerequisites:
phone:read:admin, phone:write:adminLight{
"type": "object",
"properties": {
"callId": {
"type": "string"
}
},
"required": [
"callId"
],
"additionalProperties": false
}{
"type": "object",
"properties": {
"call_id": {
"type": "string",
"description": "Unique identifier of the phone call."
},
"callee_qos": {
"type": "object",
"properties": {
"receiving": {
"type": "array",
"description": "QoS received by the callee.",
"items": {
"type": "object",
"properties": {
"date_time": {
"type": "string",
"format": "date-time",
"description": "Date and time at which the QoS was received."
},
"qos": {
"type": "object",
"properties": {
"avg_loss": {
"type": "string",
"description": "The average amount of packet loss, i.e., the percentage of packets that fail to arrive at their destination."
},
"bitrate": {
"type": "string",
"description": "The number of bits per second in kbps that can be transmitted along a digital network."
},
"jitter": {
"type": "string",
"description": "The variation in the delay of received packets. The value of this field is expressed in milliseconds."
},
"max_loss": {
"type": "string",
"description": "The max amount of packet loss, i.e., the max percentage of packets that fail to arrive at their destination."
},
"mos": {
"type": "string",
"description": "Mean Opinion Score(MOS) measures voice quality on a scale of 1 to 5. A MOS greater than or equal to 3.5 means good quality, while below 3.5 means poor quality."
},
"network_delay": {
"type": "string",
"description": "The amount of time(in milliseconds) it takes for a VoIP packet to travel from one point to another."
}
}
}
}
}
},
"sending": {
"type": "array",
"description": "QoS sent by the callee.",
"items": {
"type": "object",
"properties": {
"date_time": {
"type": "string",
"format": "date-time",
"description": "Date and time at which the QoS was delivered."
},
"qos": {
"type": "object",
"properties": {
"avg_loss": {
"type": "string",
"description": "The average amount of packet loss, i.e., the percentage of packets that fail to arrive at their destination."
},
"bitrate": {
"type": "string",
"description": "The number of bits per second expressed in kbps that can be transmitted along a digital network."
},
"jitter": {
"type": "string",
"description": "The variation in the delay of received packets. The value of this field is expressed in milliseconds."
},
"max_loss": {
"type": "string",
"description": "The max amount of packet loss, i.e., the max percentage of packets that fail to arrive at their destination."
},
"mos": {
"type": "string",
"description": "Mean Opinion Score(MOS) measures voice quality on a scale of 1 to 5. A MOS greater than or equal to 3.5 means good quality, while below 3.5 means poor quality."
},
"network_delay": {
"type": "string",
"description": "The amount of time(in milliseconds) it takes for a VoIP packet to travel from one point to another."
}
}
}
}
}
}
}
},
"caller_qos": {
"type": "object",
"description": "Quality of Service object that represents the call quality data of the caller.",
"properties": {
"receiving": {
"type": "array",
"description": "QoS received by the caller.",
"items": {
"type": "object",
"properties": {
"date_time": {
"type": "string",
"format": "date-time",
"description": "Date and time at which the QoS was received."
},
"qos": {
"type": "object",
"properties": {
"avg_loss": {
"type": "string",
"description": "The average amount of packet loss, i.e., the percentage of packets that fail to arrive at their destination."
},
"bitrate": {
"type": "string",
"description": "The number of bits per second in kbps that can be transmitted along a digital network."
},
"jitter": {
"type": "string",
"description": "The variation in the delay of received packets. The value of this field is expressed in milliseconds."
},
"max_loss": {
"type": "string",
"description": "The max amount of packet loss, i.e., the max percentage of packets that fail to arrive at their destination."
},
"mos": {
"type": "string",
"description": "Mean Opinion Score(MOS) measures voice quality on a scale of 1 to 5. A MOS greater than or equal to 3.5 means good quality, while below 3.5 means poor quality."
},
"network_delay": {
"type": "string",
"description": "The amount of time(in milliseconds) it takes for a VoIP packet to travel from one point to another."
}
}
}
}
}
},
"sending": {
"type": "array",
"description": "QoS sent by the caller.",
"items": {
"type": "object",
"properties": {
"date_time": {
"type": "string",
"format": "date-time",
"description": "Date and time at which the QoS was delivered."
},
"qos": {
"type": "object",
"properties": {
"avg_loss": {
"type": "string",
"description": "The average amount of packet loss, i.e., the percentage of packets that fail to arrive at their destination."
},
"bitrate": {
"type": "string",
"description": "The number of bits per second in kbps that can be transmitted along a digital network."
},
"jitter": {
"type": "string",
"description": "The variation in the delay of received packets. The value of this field is expressed in milliseconds."
},
"max_loss": {
"type": "string",
"description": "The max amount of packet loss, i.e., the max percentage of packets that fail to arrive at their destination."
},
"mos": {
"type": "string",
"description": "Mean Opinion Score(MOS) measures voice quality on a scale of 1 to 5. A MOS greater than or equal to 3.5 means good quality, while below 3.5 means poor quality."
},
"network_delay": {
"type": "string",
"description": "The amount of time(in milliseconds) it takes for a VoIP packet to travel from one point to another."
}
}
}
}
}
}
}
}
}
}