Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
    • Browse by device type
    • Device capabilities
      • Common methods
      • Detection and alarms
      • Image
      • PTZ
      • Light
      • Recording
      • Audio
      • Media
      • Network
      • Power
      • Privacy
      • Call
        • Doorbell parameters
        • Call session
          • Call
          • call.session.ringMuted (Read call ring mute)
          • call.session.ringMuted (Set call ring mute)
          • call.session.ringVolume (Read call ring volume)
          • call.session.ringVolume (Set call ring volume)
          • call.session.answer (Answer call)
          • call.session.hangup (Hang up call)
          • call.session.refuse (Refuse call)
          • call.session.called (Incoming call)
          • call.session.answered (Call answered)
          • call.session.hungUp (Call hung up)
          • call.session.refused (Call refused)
          • call.session.cancelled (Call cancelled)
          • call.session.videoTalk (Two-way video talk)
          • call.session.deviceTalk (Device talk)
          • call.session.channelTalk (Channel talk)
      • Storage
      • System
      • Algorithm
      • Maintenance
      • Control
    • Events overview
    • Permission codes
    • Capability error codes
    • Alarm and capability messages
    • Capability FAQ
    • Legacy ability and push types
  • API reference
  • SDK and tools
  • Solutions
  • Platform and support
On this page
What it does
Reported fields
Example
Minimum permission

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.

NameDescriptionTypeRequiredValues
modeTypeMode type.enumno1 phone; 2 indoor; 3 outdoor; 4 doorOpen
indexRingtone index. Range 0–999999, step 1.intno0–999999, step 1
callIdCall event ID.textnostring
typeCall type.enumno1 callEvent; 2 callBellEvent
descNotes (optional).textnostring
shareLinkTalkShared link supports opening audio talk first. 0 off, 1 on.enumno0 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.

call.session.refuse (Refuse call)
call.session.answered (Call answered)