Glossary
Business server (application backend)
In WeChat VoIP calling integration, the business backend you deploy. It talks to WeChat’s servers (callbacks, access_token, iot/voip/call, and related APIs), and provides a path to push messages to devices (TiMQ, long-lived connections, MQTT, and so on)—for example to deliver join WeChat VoIP calling room notifications and Mini Program user canceled call notifications.
Device side
An embedded device or simulator process running TiRTC Nano.
WeChat Mini Program
A Mini Program running inside the user’s WeChat client. It uses hardware APIs for WeChat VoIP calling device authorization and interacts with WeChat VoIP calling via plugins such as wmpf-voip.
WeChat VoIP calling room (wxa_room_id)
When the Mini Program and device are on a call, the WeChat platform creates a room; the room_id in notifications from WeChat to your business server identifies it. To distinguish this from “room” in other TiRTC scenarios, we call it wxa_room_id. Other WeChat VoIP calling terms may use a similar wxa_ prefix to indicate WeChat Mini Program context and avoid confusion with similar concepts elsewhere.
wxa_join_voip_room (join WeChat VoIP calling room notification)
During a WeChat VoIP calling session, WeChat sends a join_voip_room notification to your business server. After your server receives it, it typically calls POST /v1/token/wxvoip to obtain peer_id and token, then forwards a join WeChat VoIP calling room notification to the device—this is the main notification the device handles in the flow.
Between your business server and the device you may use any custom command or channel. The payload usually includes room/session fields plus peer_id and token for TiRtcWhipConnect.
We collectively refer to this as wxa_join_voip_room in this documentation.
See Call flows.
wxa_user_cancel (Mini Program user canceled call before answer)
Indicates events such as the Mini Program user canceling the call before it is connected. Your business server pushes this to the device; the device should stop ringing and release resources for the unanswered session.
Like wxa_join_voip_room, transport between your business server and the device is up to you.
We collectively refer to this as wxa_user_cancel in this documentation.
See Call flows.
WHIP
WebRTC-HTTP Ingestion Protocol RFC 9725. In WeChat VoIP calling, the device uses Nano’s TiRtcWhipConnect as a WHIP client; after success it establishes a peer connection with the WeChat VoIP calling service.