call.session.refused (Call refused)
call.session.refused: Call refused
call.session.refused · Device scope · Message query permission Alarm
What it does
Reported when the call is refused. The uplink msgType is call.session.refused. Subscribe to capabilityEvent to receive this push. See Receive device messages, setMessageCallback, Event catalog, and Overview and common payload.
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 |
forwardSeconds | Seconds to fast-forward (for time-based playback when the client handles the message per device rules). Range 0–99999, step 1, unit s. | int | no | 0–99999, step 1, unit s |
backwardSeconds | Seconds to rewind (for time-based playback when the client handles the message per device rules). Range 0–999999, step 1, unit s. | int | no | 0–999999, step 1, unit s |
Example
{
"msgType": "call.session.refused",
"deviceId": "TESTIPC000012345",
"productId": "56WGTET2",
"outputData": {
"modeType": "1",
"index": 0,
"callId": "example",
"type": "1",
"desc": "example",
"forwardSeconds": 0,
"backwardSeconds": 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.