@tencent-rtc/mcp 1.0.0

package/resource/doc/tuicallkit/flutter/api_TUICallDefine.md

@@ -0,0 +1,938 @@
+## Common structures
+
+### TUIResult
+
+The return value of calling the API.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Value</td>
+
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >code</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >If the code is empty "", it means the call succeeded, if the code is not empty "", it means the call failed.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >message</td>
+
+<td rowspan="1" colSpan="1" >String?</td>
+
+<td rowspan="1" colSpan="1" >Error message</td>
+</tr>
+</table>
+
+
+### TUIRoomId
+
+Room ID for audio and video in a call.
+
+**Note：**
+
+(1) `intRoomId` and `strRoomId` are mutually exclusive. If you choose to use `strRoomId`, `intRoomId` needs to be filled in as 0. If both are filled in, the SDK will prioritize `intRoomId`.
+
+(2) Do not mix `intRoomId` and `strRoomId` because they are not interchangeable. For example, the number 123 and the string "123" represent two completely different rooms.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Value</td>
+
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >intRoomId</td>
+
+<td rowspan="1" colSpan="1" >int</td>
+
+<td rowspan="1" colSpan="1" >Numeric room ID.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >strRoomId</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >String room number.</td>
+</tr>
+</table>
+
+
+### VideoRenderParams
+
+Video render parameters.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Value</td>
+
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >fillMode</td>
+
+<td rowspan="1" colSpan="1" >[FillMode](https://write.woa.com/document/114033029832187904)</td>
+
+<td rowspan="1" colSpan="1" >Video image fill mode</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >rotation</td>
+
+<td rowspan="1" colSpan="1" >[Rotation](https://write.woa.com/document/114033029832187904)</td>
+
+<td rowspan="1" colSpan="1" >Video image rotation direction</td>
+</tr>
+</table>
+
+
+### VideoEncoderParams
+
+Video encoding parameters.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Value</td>
+
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >resolution</td>
+
+<td rowspan="1" colSpan="1" >[Resolution](https://write.woa.com/document/114033029832187904)</td>
+
+<td rowspan="1" colSpan="1" >Video resolution</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >resolutionMode</td>
+
+<td rowspan="1" colSpan="1" >[ResolutionMode](https://write.woa.com/document/114033029832187904)</td>
+
+<td rowspan="1" colSpan="1" >Video aspect ratio mode</td>
+</tr>
+</table>
+
+
+### TUICallParams
+
+Call params.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Value</td>
+
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >roomId</td>
+
+<td rowspan="1" colSpan="1" >[TUIRoomId](https://write.woa.com/document/114033029832187904)</td>
+
+<td rowspan="1" colSpan="1" >Room Id.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >offlinePushInfo</td>
+
+<td rowspan="1" colSpan="1" >[TUIOfflinePushInfo](https://write.woa.com/document/114033029832187904)</td>
+
+<td rowspan="1" colSpan="1" >Offline push vendor configuration information.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >timeout</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Call timeout period, default: 30s, unit: seconds.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >userData</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >An additional parameter. </td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >chatGroupId</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Group ID.</td>
+</tr>
+</table>
+
+
+### TUIOfflinePushInfo
+
+Offline push vendor configuration information，please refer to:[Offline call push](https://write.woa.com/document/95821638488313856).
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Value</td>
+
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >title</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >offlinepush notification title</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >desc</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >offlinepush notification description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >ignoreIOSBadge</td>
+
+<td rowspan="1" colSpan="1" >bool</td>
+
+<td rowspan="1" colSpan="1" >Ignore badge count for offline push (only for iOS), if set to true, the message will not increase the unread count of the app icon on the iOS receiver's side.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >iOSSound</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Offline push sound setting (only for iOS). When<br>sound = IOS_OFFLINE_PUSH_NO_SOUND<br>, there will be no sound played when the message is received. When <br>sound = IOS_OFFLINE_PUSH_DEFAULT_SOUND<br>, the system sound will be played when the message is received. If you want to customize the iOSSound, you need to link the audio file into the Xcode project first, and then set the audio file name (with extension) to the iOSSound.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >androidSound</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Offline push sound setting (only for Android, supported by IMSDK 6.1 and above). Only Huawei and Google phones support setting sound prompts. For Xiaomi phones, please refer to: <br>Xiaomi custom ringtones<br>. In addition, for Google phones, in order to set sound prompts for FCM push on Android 8.0 and above systems, you must call <br>setAndroidFCMChannelID<br>to set the channelID for it to take effect.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >androidOPPOChannelID</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Set the channel ID for OPPO phones with Android 8.0 and above systems.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >androidVIVOClassification</td>
+
+<td rowspan="1" colSpan="1" >int</td>
+
+<td rowspan="1" colSpan="1" >Classification of VIVO push messages (deprecated interface, VIVO push service will optimize message classification rules on April 3, 2023. It is recommended to use setAndroidVIVOCategory to set the message category). 0: Operational messages, 1: System messages. The default value is 1.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >androidXiaoMiChannelID</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Set the channel ID for Xiaomi phones with Android 8.0 and above systems.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >androidFCMChannelID</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Set the channel ID for google phones with Android 8.0 and above systems.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >androidHuaWeiCategory</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Classification of Huawei push messages, please refer to:<br>[Huawei message classification standard.](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >isDisablePush</td>
+
+<td rowspan="1" colSpan="1" >bool</td>
+
+<td rowspan="1" colSpan="1" >Whether to turn off push notifications (default is on).</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >iOSPushType</td>
+
+<td rowspan="1" colSpan="1" >[TUICallIOSOfflinePushType](https://write.woa.com/document/114033029832187904)</td>
+
+<td rowspan="1" colSpan="1" >iOS offline push type，default is APNs</td>
+</tr>
+</table>
+
+
+### TUICallRecords
+
+Call recording information.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Value</td>
+
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >callId</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Call recording ID.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >inviter</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Inviter ID.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >inviteList</td>
+
+<td rowspan="1" colSpan="1" >List<String></td>
+
+<td rowspan="1" colSpan="1" >List of invited user IDs.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >scene</td>
+
+<td rowspan="1" colSpan="1" >[TUICallScene](https://write.woa.com/document/114033029832187904)</td>
+
+<td rowspan="1" colSpan="1" >Call scenario.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >mediaType</td>
+
+<td rowspan="1" colSpan="1" >[TUICallMediaType](https://write.woa.com/document/114033029832187904)</td>
+
+<td rowspan="1" colSpan="1" >Media type.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >groupId</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Group ID.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >role</td>
+
+<td rowspan="1" colSpan="1" >[TUICallRole](https://write.woa.com/document/114033029832187904)</td>
+
+<td rowspan="1" colSpan="1" >Role.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >result</td>
+
+<td rowspan="1" colSpan="1" >[TUICallResultType](https://write.woa.com/document/114033029832187904)</td>
+
+<td rowspan="1" colSpan="1" >Call result type.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >beginTime</td>
+
+<td rowspan="1" colSpan="1" >int</td>
+
+<td rowspan="1" colSpan="1" >Start time.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >totalTime</td>
+
+<td rowspan="1" colSpan="1" >int</td>
+
+<td rowspan="1" colSpan="1" >Total time.</td>
+</tr>
+</table>
+
+
+### TUICallRecentCallsFilter
+
+Call recording filtering conditions.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Value</td>
+
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >begin</td>
+
+<td rowspan="1" colSpan="1" >double</td>
+
+<td rowspan="1" colSpan="1" >Start time.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >end</td>
+
+<td rowspan="1" colSpan="1" >double</td>
+
+<td rowspan="1" colSpan="1" >End time.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >resultType</td>
+
+<td rowspan="1" colSpan="1" >[TUICallResultType](https://write.woa.com/document/114033029832187904)</td>
+
+<td rowspan="1" colSpan="1" >Call result type.</td>
+</tr>
+</table>
+
+
+### CallObserverExtraInfo
+
+Callback extended information.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >roomId</td>
+
+<td rowspan="1" colSpan="1" >[TUIRoomId](https://write.woa.com/document/114033029832187904)</td>
+
+<td rowspan="1" colSpan="1" >room ID</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >role</td>
+
+<td rowspan="1" colSpan="1" >[TUICallRole](https://write.woa.com/document/114033029832187904)</td>
+
+<td rowspan="1" colSpan="1" >Call role</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >userData</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Custom extended field when initiating a call. For details, see [TUICallParams](https://write.woa.com/document/114033029832187904).</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >chatGroupId</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Group ID</td>
+</tr>
+</table>
+
+
+## **enum definition**
+
+### TUICallMediaType
+
+Call media type.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >none</td>
+
+<td rowspan="1" colSpan="1" >Unknown</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >audio</td>
+
+<td rowspan="1" colSpan="1" >Audio call</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >video</td>
+
+<td rowspan="1" colSpan="1" >Video call</td>
+</tr>
+</table>
+
+
+### TUICallRole
+
+Call role.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >none</td>
+
+<td rowspan="1" colSpan="1" >Unknown</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >caller</td>
+
+<td rowspan="1" colSpan="1" >Caller（inviter）</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >called</td>
+
+<td rowspan="1" colSpan="1" >Callee（invitee）</td>
+</tr>
+</table>
+
+
+### TUICallStatus
+
+Call status.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >none</td>
+
+<td rowspan="1" colSpan="1" >Unknown</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >waiting</td>
+
+<td rowspan="1" colSpan="1" >The call is currently waiting</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >accept</td>
+
+<td rowspan="1" colSpan="1" >The call has been accepted</td>
+</tr>
+</table>
+
+
+### TUICallScene
+
+Call scene.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >groupCall</td>
+
+<td rowspan="1" colSpan="1" >Group call </td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >singleCall</td>
+
+<td rowspan="1" colSpan="1" >one to one call</td>
+</tr>
+</table>
+
+
+### TUINetworkQuality
+
+Network quality.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >unknown</td>
+
+<td rowspan="1" colSpan="1" >Unknown</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >excellent</td>
+
+<td rowspan="1" colSpan="1" >Excellent</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >good</td>
+
+<td rowspan="1" colSpan="1" >Good</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >poor</td>
+
+<td rowspan="1" colSpan="1" >Poor</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >bad</td>
+
+<td rowspan="1" colSpan="1" >Bad</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >vBad</td>
+
+<td rowspan="1" colSpan="1" >Very bad</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >down</td>
+
+<td rowspan="1" colSpan="1" >Down</td>
+</tr>
+</table>
+
+
+### FillMode
+
+If the aspect ratio of the video display area is not equal to that of the video image, you need to specify the fill mode:
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >fill</td>
+
+<td rowspan="1" colSpan="1" >Fill mode: the video image will be centered and scaled to fill the entire display area, where parts that exceed the area will be cropped. The displayed image may be incomplete in this mode.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >fit</td>
+
+<td rowspan="1" colSpan="1" >Fit mode: the video image will be scaled based on its long side to fit the display area, where the short side will be filled with black bars. The displayed image is complete in this mode, but there may be black bars.</td>
+</tr>
+</table>
+
+
+### Rotation
+
+We provides rotation angle setting APIs for local and remote images. The following rotation angles are all clockwise.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >rotation_0</td>
+
+<td rowspan="1" colSpan="1" >No rotation</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >rotation_90</td>
+
+<td rowspan="1" colSpan="1" >Clockwise rotation by 90 degrees</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >rotation_180</td>
+
+<td rowspan="1" colSpan="1" >Clockwise rotation by 180 degrees</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >rotation_270</td>
+
+<td rowspan="1" colSpan="1" >Clockwise rotation by 270 degrees</td>
+</tr>
+</table>
+
+
+### ResolutionMode
+
+Video aspect ratio mode.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >landscape</td>
+
+<td rowspan="1" colSpan="1" >Landscape resolution, such as Resolution.Resolution_640_360 + ResolutionMode.Landscape = 640 × 360.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >portrait</td>
+
+<td rowspan="1" colSpan="1" >Portrait resolution, such as Resolution.Resolution_640_360 + ResolutionMode.Portrait = 360 × 640.</td>
+</tr>
+</table>
+
+
+### Resolution
+
+Video resolution.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >resolution_640_360</td>
+
+<td rowspan="1" colSpan="1" >Aspect ratio: 16:9；resolution: 640x360；recommended bitrate: 500kbps</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >resolution_960_540</td>
+
+<td rowspan="1" colSpan="1" >Aspect ratio: 16:9；resolution: 960x540；recommended bitrate: 850kbps</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >resolution_1280_720</td>
+
+<td rowspan="1" colSpan="1" >Aspect ratio: 16:9；resolution: 1280x720；recommended bitrate: 1200kbps</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >resolution_1920_1080</td>
+
+<td rowspan="1" colSpan="1" >Aspect ratio: 16:9；resolution: 1920x1080；recommended bitrate: 2000kbps</td>
+</tr>
+</table>
+
+
+### TUICallIOSOfflinePushType
+
+iOS offline push type.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >APNs</td>
+
+<td rowspan="1" colSpan="1" >APNs</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >VoIP</td>
+
+<td rowspan="1" colSpan="1" >VoIP</td>
+</tr>
+</table>
+
+
+### TUICamera
+
+Camera type.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >front</td>
+
+<td rowspan="1" colSpan="1" >Front camera.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >back</td>
+
+<td rowspan="1" colSpan="1" >Rear camera.</td>
+</tr>
+</table>
+
+
+### TUIAudioPlaybackDevice
+
+Audio playback device.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >speakerphone</td>
+
+<td rowspan="1" colSpan="1" >Speaker</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >earpiece</td>
+
+<td rowspan="1" colSpan="1" >Earpiece</td>
+</tr>
+</table>
+
+
+### TUICallResultType
+
+Call recording type.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >unknown</td>
+
+<td rowspan="1" colSpan="1" >Unknown</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >missed</td>
+
+<td rowspan="1" colSpan="1" >Missed</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >incoming</td>
+
+<td rowspan="1" colSpan="1" >Incoming call</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >outgoing</td>
+
+<td rowspan="1" colSpan="1" >Outgoing Call</td>
+</tr>
+</table>
+
+
+### CallEndReason
+
+Call end reason.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >unknown</td>
+
+<td rowspan="1" colSpan="1" >Unknown</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >hangup</td>
+
+<td rowspan="1" colSpan="1" >Hang up</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >reject</td>
+
+<td rowspan="1" colSpan="1" >Deny</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >noResponse</td>
+
+<td rowspan="1" colSpan="1" >No response</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >offline</td>
+
+<td rowspan="1" colSpan="1" >Offline</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >lineBusy</td>
+
+<td rowspan="1" colSpan="1" >Busy Line</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >canceled</td>
+
+<td rowspan="1" colSpan="1" >Cancel call</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >otherDeviceAccepted</td>
+
+<td rowspan="1" colSpan="1" >Other device answers</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >otherDeviceReject</td>
+
+<td rowspan="1" colSpan="1" >Other device denies</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >endByServer</td>
+
+<td rowspan="1" colSpan="1" >Backend ends</td>
+</tr>
+</table>