Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
  • API reference
    • Public conventions
    • Development specification
    • accessToken: Get administrator token
    • API request example
    • Return codes
    • Interface call limits
    • Account docking
    • Device APIs
    • Device live broadcast
    • Push configuration
    • Cloud storage service
    • Resource pool quota
    • Legacy APIs (deprecated)
      • Door lock access (legacy)
        • deleteDoorKey
        • doorbellCallAnswer
        • doorbellCallHangUp
        • doorbellCallRefuse
        • generateSnapkey
        • getDevicePowerInfo
        • getDoorKeys
        • getOpenDoorRecord
        • getSnapkeyList
        • openDoorRemote
        • wakeUpDevice
      • Device messages (legacy)
      • Device query (deprecated)
      • Device maintenance (legacy)
      • Device operation (legacy)
      • Device ability (legacy)
      • Motion detection config (legacy)
      • Preset collection (legacy)
      • Timed cruise (legacy)
      • Local recording config (legacy)
      • Audio volume (legacy)
      • Storage (legacy)
      • Video and imaging (legacy)
      • Time zone (legacy)
      • Wi-Fi (legacy)
      • Local recording query (legacy)
  • SDK and tools
  • Solutions
  • Platform and support
On this page
Function details
Request address
Request format
The minimum permissions required for sub-account token request
Incoming parameter description
Sample input
Return data field description
Sample output
Error codes
Related

doorbellCallRefuse (doorbellCallRefuse: Refuse the call of Video Intercom Outdoor(VTO)/doorbell)

doorbellCallRefuse: doorbellCallRefuse: Refuse the call of Video Intercom Outdoor(VTO)/doorbell

Legacy HTTP retained: New integrations can use Doorbell (call.doorbell) for the related capability. The two interfaces are not a one-to-one replacement. No registry one-to-one mapping for this door/doorbell HTTP method.

Function details

Refuse the call of the VTO/doorbell device, when it is in the calling state.

Request address

https://openapi-[DataCenter].easy4ip.com/openapi/doorbellCallRefuse

Request format

HTTP POST. JSON body layout: Request conventions. Sign with Signature.

The minimum permissions required for sub-account token request

"Permission":"DevControl" "Resource":"dev:serial number"

Incoming parameter description

Parameter nameParameter typeRequired or notDefault valueLegal valueParameter description
tokenStringYesAdministrator or sub-account accessToken
deviceIdStringYesDevice serial number

Sample input

{
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1632901223,
 "nonce": "663b7211-747e-4263-8755-e8242629ea1d"
 },
 "id": "a05eb91f-7738-4a8a-99f8-a60ca5a960f8",
 "params": {
 "deviceId": "TESTQWERXXXX",
 "token": "At_00000ec6fec122bd4e42949c469a3ace"
 }
}

Return data field description

No data returned

Sample output

{
 "result": {
 "msg": "Operation Successful",
 "code": "0"
 },
 "id": "a05eb91f-7738-4a8a-99f8-a60ca5a960f8"
}

Error codes

This method may return the codes below. See Return codes and Capability errors for the full catalog.

Gateway and auth (SN / TK / OP)

CodeMeaningNext step
SN1001Signature errorCheck sign per Development specification
TK1002Token invalid or expiredRefresh accessToken
OP1002Missing required parameterAdd required fields
OP1003Invalid parameterMatch this page’s parameter table
OP1009Permission deniedCheck token and device bind/share grants
OP1013Total call limit exceededReduce call rate
OP1014Daily per-interface limit exceededSee Interface call limits
DV1007Device offlineWait until the device is online

See Return codes · OP/SN/TK for the full catalog.

Sub-accounts (SUB)

CodeMeaningNext step
SUB1001–SUB1002Sub-account lacks API permissionUpdate policy via addPolicy
SUB1005Sub-account token expiredRefresh subAccountToken
SUB1006No device grant for sub-accountCheck Resource and device serial
SUB1008Sub-account not bound to appCreate and bind the sub-account first

See Return codes · SUB.

Device access and channels (DV10xx)

CodeMeaningNext step
DV1007Device offline or timeoutWait for the device to come online
DV1009Device busyRetry later
DV1012Insufficient share/grant permissionCheck sub-account Permission / Resource
DV1019Capability not supportedConfirm model and capability list
DV1020Channel offlineCheck channel status
DV1026Function not supportedUse another API or upgrade firmware
DV1028Not bound or channel missingVerify deviceId / channelId

See Return codes · DV.

Lock and doorbell (DV10xx)

CodeMeaningNext step
DV1016Device password errorVerify lock password
:---:---:---
DV1038Battery too low for temporary keyCharge and retry
:---:---:---
DV1039Temporary key conditions not metAdjust parameters per this page
:---:---:---
DV1050Temporary key count limitDelete old keys or wait
:---:---:---
DV1070Doorbell/intercom busyRetry or hang up

See Return codes · catalog.

Related

  • Development specification
  • API conventions
  • Module index
doorbellCallHangUp
generateSnapkey