call.session.called (Incoming call)
call.session.called: Incoming call
call.session.called · Device scope · Message query permission Alarm
What it does
Doorbell/intercom incoming call (Alarm event call.session.called). Typical flow: this event → SDK/legacy answer/hang up/refuse (not device.service.invoke) → answered/hungUp/refused/cancelled. See Event catalog · Answer call and other discovery pages · Mobile app development.
Reported fields
Fields inside outputData. Platform fields: Overview and common payload.
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
modeType | Mode type. | enum | no | 1 phone; 2 indoor; 3 outdoor; 4 doorOpen |
index | Ringtone index. Range 0–999999, step 1. | int | no | 0–999999, step 1 |
callId | Call event ID. | text | no | string |
type | Call type. | enum | no | 1 callEvent; 2 callBellEvent |
desc | Notes (optional). | text | no | string |
shareLinkTalk | Shared link supports opening audio talk first. 0 off, 1 on. | enum | no | 0 off; 1 on |
Example
{
"msgType": "call.session.called",
"deviceId": "TESTIPC000012345",
"productId": "56WGTET2",
"outputData": {
"modeType": "1",
"index": 0,
"callId": "example",
"type": "1",
"desc": "example",
"shareLinkTalk": "0"
},
"time": 1673406989,
"localTime": "20230111T111629",
"alarmId": "116257862023505xxxx"
}
Minimum permission
The administrator does not need an extra permission on a device they bound. A shared device needs the alarm-message permission. A bound sub-user does not. A sub-account needs Alarm. list/search filters out events you are not allowed to see. Call session.
