LAN-2-LAN API
FOR DOORBIRD AND BIRDGUARD
OVERVIEW
!" #$
%"!&'#$
( )( '*+,%-#$
COPYRIGHT NOTICE
%&%#$
.$%,%'%'
'#$ .$
BETA AND SUPPORT NOTICE
This API is currently in beta status and is subject to change without prior
notice. This API is not part of the product purchase and thus comes without
any kind of support and without any kind of warranty.
LICENSE AGREEMENT
( & )/(0+ & & ' % )
%+#$ .$)/#$ 0+
#%&"12 31"12 31143"!"5)'+,
'',%&%(
1. GRANT OF LICENSE
# $ % & % & #" $561
756 "5 ( !" )/"12 310+ '
"12 31)/"12 31143"!"50+
&,&&&%
&#$ '*,
%#$ )/#$ !0+
*,%
2. COPYRIGHT
"12 31 "12 31143"!"5 '% # $
%%&'%
% "12 31 8"12 31 143"!"5
4%
3. RESTRICTIONS ON USE
9&'"12 31,"12 31143"!"5
Copyright © 2023 by Bird Home Automation GmbH
%"12 31,"12 31143"!"5
%%9%
&,,"12 31:
% ' % &
%%'
4. THIRD PARTY RIGHTS
9 & % % % ' ' &
"12 31&&%#$ !%
:#$ !%
'%3:%,%&;
)+%'%&
'&#$ , '
#$ &%
)+%&%'&
'#$ !,#
$ ,&%
%&%%
5. TERMINATION
(9&('
%'#$ %%'%
)+(7(,%
"12 318$1"12 31143"!"5'
4
6. REPRESENTATIONS AND WARRANTIES; DISCLAIMER
9')+%,8
% % ' & # $ !
&'%%&,&
% % &< )+ % "12 31
"12 31 143"!"5 ' % ' &
',&
95774152$1"12 31"4 95745(1"4=$1"12 31
$1"12 31143"!"5 11(">11211523$ .1
? 4"4?@"$57@ 952 9="$11"1"4= 45$1
741, 147(4 !1256 31 52 $1 "12 31 $1
"12 31 143"!"5 "4 44761 #9 $1 7418957 #" $561
756 "5 "43( "64 (( @ "14, @$1$1 1A!144 5
"6!("1,"3(7".#75("6"15,$1"6!("1@ "1452
613$ #"("9, 2"144 25 ! "37( !7!541, "(1, 5-
"2".161 !573(" #"("9,5 9@ 9 "4".57
52 9 !5!54 (, 4!13"2"3 "5 5 4 6!(1 @"$ 14!13 5 $1
"12 31 $1"12 31143"!"5
@&&%&&,%*'&&#
$ *%'%&
#$ !%&%%
&9%%%&
,%%
'&#$ !#$ '
Copyright © 2023 by Bird Home Automation GmbH
&&%,%&
&%&&%
%%%'
$"4 ("3141 514 5 35>19 9 ("3141 5 $" ! 9
"1((137 ( !5!19 957 1 45(1(9 14!54"#(1 25 )"+
1A 6"".@$1$1$1"12 31 $1"12 31143"!"5
1 1376#11 #9 5 "2".14 7!5 ".$ $1( #9 $"
! 9 )""+ 9"1((137 (!5!19"2".1613( "64$
"41575251( 1545(7"5431 1,6 72 371
"4"#71 #9 957 @$"3$ "1. 1 #" $561 756 "5
!5734
DOCUMENT HISTORY
>
& /0
:3&'$!4
7'* 138
B $%&
C % #
*3D:
,&,8,,&,
%&
,*:
/ !"0'E
%
7!,,
1&)6 3,%%+
1%&:)*+
"4"! !"4"! !"'/ !"
0,%/FF0'
G &&
&&
&
/&0
7&-
&3&*$!4
Copyright © 2023 by Bird Home Automation GmbH
D 2'*%
/&0
H /%0$!
/1>165"5".)7!
#5 3 44+04%44(&$!47(
B &-&
C
G #''
BC
3'-'%4"!'
&-
"/&FF0/FF04"!
!"
-&
D &%'
-/1>165"5".)7!#5 3 44+0,'
'&
/35371
3513"54 1("6"40
H 2*7!)+
*%&7!
COMPATIBLE DEVICES
$' 2'
#>4 GG
#>4 GG
#>4 C
#.# GG
#>4
!*2'3&(&88'''8&&
*'
2%,'/0/#>
40/#.0/0
Copyright © 2023 by Bird Home Automation GmbH D
GENERAL INFORMATION
PRIVACY STATEMENT
! % %- %&&
%
'%-%
LOCATING DEVICES IN YOUR LAN
9"!'%( &
#I!,&
# J4&J J4
588'''8*
#I/-0,&/--#FF
0! #I
88'*&8'*8#IFKC'KG
88'''888--%8'
CONCURRENT CONNECTIONS AND RATE LIMITS
-% !"
!"
!"'&"'*
"!'%
'&%$!D
Please keep in mind that the device is a Video Door Station, which handles in
general - like all commercially relevant door stations - only one simultaneous
audio/video call for live communication. You get a status code "503" (Busy) if another
user already took the call. In that case you can notify the user with a message dialog
on your GUI, e.g. "Line busy" and additionally preview one still image (LIVE IMAGE
REQUEST).
INTEGRATION SCHEME
'& &' 9
;%&*
Copyright © 2023 by Bird Home Automation GmbH H
)& , , - + 7!
#&'( "7!#
&)-+%
,%?&-&?
1- % * - % &
&
6745%
7! # &, > 4
%'%C.$;5-33!7'.# 6
%
>4)'%+&
' % % ), + L
%)+
*!%'-%
;&' >
4
@1-*-)%&&
+>
4" > 4 %
%&1-
'&?(%,%*&?%
URL SCHEME
7(-4'# 54
Copyright © 2023 by Bird Home Automation GmbH
**&#
.'7(4'
&&&54
888%888!838
!54!&&.8"- 38"-
3M88F888!DBB-3$-4@
888&888&
Calling URL
# &7(-488'
''
%7(544
' /7(440
Available services
5#
doorbird://
5# ,'#E
"'"#E,%
doorbird://live/%id
5# )
#DD+
doorbird://nofullscreen
D5# ,'
#E"'"
#E,% )#
DD+
doorbird://nofullscreen/live/%id
"&#E
"
Example
Copyright © 2023 by Bird Home Automation GmbH B
7
888
HTTP INTERFACE DESCRIPTION
AUTHENTICATION
!#&23B$!
:7%&#
%23B%%-
$!?-??-'?)
-,-%%
$!+,&?88N-O8-8&P-
QR-'Q?
ENCRYPTION
%'#3%
%'%&%
$!-%&%
3!C)$!+%3!DD)$!4+
'*)( +3 )3 +
"!,-&-$!4
( -%&
%:;'88N-O8)+
88N-O8)+'*-%&
1>--&:%'
'*-%&2--&
:,%%)L+4"
4"%%--&:,
)-&
88N-O88-8&PQN-O,-&
88N-O88-8-&PQN-O+
!*%--&
)&'&'&,-&'&
%&/---Q0/-3 ?
%)+%&'&/---
*-0+
%4")+,'&
Copyright © 2023 by Bird Home Automation GmbH C
4"%
Method: .1
Required permission:
Syntax:
http://<device-ip>/bha-api/getsession.cgi
Example Request:
http://<device-ip>/bha-api/getsession.cgi
Return:
HTTP/1.1 200 OK
Content-Type: application/json
{ "BHA": {
"RETURNCODE": "1",
"SESSIONID":
"ISXA9dzpUfPUSlRNfufdOgGDWRy9WadbtXtB45v9YFc3jMLf4yR50a37gak9f",
"NOTIFICATION_ENCRYPTION_KEY":
"7zsuPtzNJZc72Fc2CI13cwz3ROqw2eOEtFlZy465JB2AyE2m0qrHhQqgrSXh13Ti"
}
}
8%4",'&
Method: .1
Required permission:
Syntax:
http://<device-ip>/bha-api/getsession.cgi?<parameter>=<value>
NOQNO >
QN&O NFFO $-%'
&:
Example Request:
http://<device-ip>/bha-api/getsession.cgi?invalidate=
ISXA9dzpUfPUSlRNfufdOgGDWRy9WadbtXtB45v9YFc3jMLf4yR50a37gak9f
Return:
HTTP/1.1 200 OK
Content-Type: application/json
{ "BHA": {
"RETURNCODE": "1",
"SESSIONID": "" }
Copyright © 2023 by Bird Home Automation GmbH G
}
AVAILABLE PERMISSIONS
7,'&
#
Watch always7'8%,
&
History7%)&3-&+
Motion7%
)&3-&+
API-Operator7&&&5 !"
)'''8+&&
4"!)/*0+& !"9%
/ !"-50'$
4,%5/ !"-50
'&$ -
&&&
DEMONSTRATION
9%'88N-O8-8''''
!"'&
Copyright © 2023 by Bird Home Automation GmbH
LIVE VIDEO REQUEST
S!1. '
%&@6S!.:,
'S!1.%?8-
-? & ' % & N%O
&$!::&:
&C&-% !",&
'*
@:,:&'
,:''D
%'/'-'%0''&
H
!,&%,'
# :"( -
!"
Method: .1
Required permission:,/''%0&H:&
Syntax:
http://<device-ip>/bha-api/video.cgi
Example Request:
http://<device-ip>/bha-api/video.cgi
Return:
HTTP/1.0 200 OK\r\n
Content-Type: multipart/x-mixed-replace;boundary=<boundary>\r\n
\r\n
<boundary>\r\n
<image section>\r\n
<boundary>\r\n
<image section>\r\n
:
:
'NboundaryO/%-%0Nimage sectionO
Content-Type: image/jpeg\r\n
Content-Length: <image size>\r\n
\r\n
<JPEG image data>
Example: :6S!1.&
Copyright © 2023 by Bird Home Automation GmbH
LIVE IMAGE REQUEST
S!1.'
%&%?&8I&?
@:,:&'
&,:''D%
'/'-'%0''&
H
Method: .1
Required permission:,/''%0&:&
Syntax:
http://<device-ip>/bha-api/image.cgi
Example Request:
http://<device-ip>/bha-api/image.cgi
Return:
HTTP/1.0 200 OK\r\n
Content-Type: image/jpeg\r\n
Content-Length: <image size>\r\n
\r\n
<JPEG image data>\r\n
Copyright © 2023 by Bird Home Automation GmbH
OPEN DOOR
1&;8%S45
@, !"'&
&& % 4, ' : , :&
'&,:''
D%'/'-'%0'
'&H
Method: .1
Required permission:,/''%0&H:&
Syntax:
http://<device-ip>/bha-api/open-door.cgi?<parameter>=<value>
NOQNO >
QN&O TTN"OUN%O %&&,&
%%%
"!"8539
&%&
&)&
",
%%&&&
Example Requests:
http://<device-ip>/bha-api/open-door.cgi
http://<device-ip>/bha-api/open-door.cgi?r=1
http://<device-ip>/bha-api/open-door.cgi?r=gggaaa@1
Copyright © 2023 by Bird Home Automation GmbH
LIGHT ON
1&;&%S45
@, !"'&&
4,':,:&'
&,:''D
%'/'-'%0''&
H
Method: .1
Required permission:,/''%0&H:&
Syntax:
http://<device-ip>/bha-api/light-on.cgi
Example Request:
http://<deviceip>/bha-api/light-on.cgi
Copyright © 2023 by Bird Home Automation GmbH D
HISTORY IMAGE REQUEST
S!1. % & '
%&%&
":&*,
%,:''D
&/%0/0
Method: .1
Required permission:,%,&
Syntax:
http://<device-ip>/bha-api/history.cgi?<parameter>=<value>
NOQNO >
QNO H "%&,'
%&
QN&O T 1%)+,&
%#
&&%#.
!"%:&
%:&
)*%'&
&&+
Example Request:
http://<deviceip>/bha-api/history.cgi?index=1
http://<deviceip>/bha-api/history.cgi?index=22
http://<deviceip>/bha-api/history.cgi?
event=motionsensor&index=5
Return:
HTTP/1.0 200 OK\r\n
Content-Type: image/jpeg\r\n
Content-Length: <image size>\r\n
\r\n
<JPEG image data>\r\n
MONITOR REQUEST
&&*%&C
4'@%$!HG
Method: .1
Copyright © 2023 by Bird Home Automation GmbH H
Required permission:
Syntax:
http://<device-ip>/bha-api/monitor.cgi?ring=doorbell[,motionsensor]
NOQNO >
&QN&O T
1%
Note*%&
Example Request:
http://<device-ip>/bha-api/monitor.cgi?ring=doorbell,motionsensor
Example Return:
HTTP/1.1 200 OK\r\n
Content-Type: multipart/x-mixed-replace; boundary=--ioboundary\r\n
\r\n
--ioboundary\r\n
Content-Type: text/plain\r\n
\r\n
doorbell:H\r\n
\r\n
--ioboundary\r\n
Content-Type: text/plain\r\n
\r\n
motionsensor:L\r\n
\r\n
..
--ioboundary\r\n
Content-Type: text/plain\r\n
\r\n
doorbell:L\r\n
\r\n
--ioboundary\r\n
Content-Type: text/plain\r\n
\r\n
motionsensor:L\r\n
\r\n
HTTP status codes:
V5=
DV!&
DV :
Copyright © 2023 by Bird Home Automation GmbH
LIVE AUDIO RECEIVE AND TRANSMIT – General information
$!4"!
138 &)&$ +674
') 13, +#>
4&-'-'-
-, % %
,5
&- -& 13 & 5 13
& &
%%9 138 %'
138 &%,&
888%888
6 838 7$&.F548
7&4 787&4 7
8888888
13
3@& !"674.BW-')&C
$;+
@*@&@**&,
&'/0 2,
LIVE AUDIO RECEIVE
7-).BX-'+
@:,:&'
,:''D
%'/'-'%0''&
H
!,&%,'
# :"( -
!"
Method: .1
Required permission:,/''%0&H:&
Syntax:
http://<device-ip>/bha-api/audio-receive.cgi
Example Request:
http://<device-ip>/bha-api/audio-receive.cgi
Return:
Copyright © 2023 by Bird Home Automation GmbH B
HTTP/1.0 200 OK\r\n
<AUDIO DATA>
<AUDIO DATA>
<AUDIO DATA>
...
LIVE AUDIO TRANSMIT
).BX-'+%)&$ +
5%)*+
'I
@:,:&'
,:''D
%'/'-'%0''&
H
!,&%,'
# :"( -
!"
Method: !54
Required permission:,/''%0&H:&
Syntax:
http://<device-ip>/bha-api/audio-transmit.cgi
Example 1: 4&'.BX-');+
POST /bha-api/audio-transmit.cgi HTTP/1.0\r\n
Content-Type: audio/basic\r\n
Content-Length: 9999999\r\n
Connection: Keep-Alive\r\n
Cache-Control: no-cache\r\n
\r\n
<AUDIO DATA>
<AUDIO DATA>
<AUDIO DATA>
...
Example 2: 7&'&
gst-launch-1.0 alsasrc ! queue ! audioconvert ! audioresample ! "audio/x-
raw,format=S16LE,rate=8000,channels=1" ! mulawenc ! "audio/x-
mulaw,rate=8000,channels=1" ! curlhttpsink
location=http://<device-ip>/bha-api/audio-transmit.cgi content-
type="audio/basic" use-content-length=true user=xxxxxx0001 passwd=xxxxxxxx
Copyright © 2023 by Bird Home Automation GmbH C
Example 3: 7&'
curl -v --http1.0 -H "Content-Type: audio/basic" -H "Content-Length:
9999999" -H "Connection: Keep-Alive" -H "Cache-Control: no-cache" --data-
binary "@audio_file.ulaw" 'http://userxx0001:passwordxx@<device-ip>/bha-
api/audio-transmit.cgi' --limit-rate 8K
INFO REQUEST
.S454&''
C,%&S45",
%%#"!"853
Method: .1
Required permission:
Syntax:
http://<device-ip>/bha-api/info.cgi
Example Request:
http://<deviceip>/bha-api/info.cgi
Example Return 1:#''
{
"BHA": {
"RETURNCODE": "1",
"VERSION": [{
"FIRMWARE": "000096",
"BUILD_NUMBER": "41865"
}]
}
}
Example Return 2:#'#"!"853
{
"BHA": {
"RETURNCODE": "1",
"VERSION": [{
"FIRMWARE": "000109",
"BUILD_NUMBER": "15120529",
"PRIMARY_MAC_ADDR": "1CCAE3700000",
"RELAYS": ["1", "2", "gggaaa@1", "gggaaa@2"],
"DEVICE-TYPE": "DoorBird D101"
}]
}
}
FAVORITE MANAGEMENT
Copyright © 2023 by Bird Home Automation GmbH G
"#, !"
2&
,&$!)4+-7(4"!2
*"%'$!
)&+,E'
%7(
/ !"0&
2'&:%#8#.
!&( --( !",'*
%$!4"&
"!%$!4'
%
LIST FAVORITES
(%&S45
Method: .1
Required permission:, !"
Syntax:
http://<device-ip>/bha-api/favorites.cgi
Example Request:
http://<device-ip>/bha-api/favorites.cgi
Return:
HTTP/1.0 200 OK\r\n
\r\n
{
"sip":{
"0":{
"title":"Concierge",
"value":"[email protected]"
}
},
"http":{
"1":{
"title":"MyServer",
"value":"http://10.0.0.1/foo/notify"
},
"5":{
"title":"ServerX",
Copyright © 2023 by Bird Home Automation GmbH
"value":"https://login:[email protected]?
action=notify"
}
}
}
ADD OR CHANGE FAVORITE
'&&"%',E
*%/0
Method: .1
Required permission:, !"
Syntax:
http://<device-ip>/bha-api/favorites.cgi?
action=save&<parameter>=<value>
NOQNO >
QN&O 2&
%QN&O T %< 1"5E'
'%'&&L
QN&O 8
QN&O 7(8 7(,&
,%)+
$!)4+7(4"!&
QNO
4%"&<,
&'
Example Requests:$!,&4"!
http://<device-ip>/bha-api/favorites.cgi?
action=save&type=http&title=RingServ&value=https://
172.17.1.5/notify/ring
http://<device-ip>/bha-api/favorites.cgi?
action=save&type=sip&title=Johns
%20Phone&[email protected]&id=2
Return:
HTTP/1.0 200 OK\r\n
\r\n
HTTP status codes:
Copyright © 2023 by Bird Home Automation GmbH
V5=
DV!&
DV :
HV"
HBV4;)%&+
DELETE FAVORITE
#"%
&,%'
Method: .1
Required permission:, !"
Syntax:
http://<device-ip>/bha-api/favorites.cgi?
action=remove&<parameter>=<value>
NOQNO >
QN&O 2&
%QN&O T %
QNO " "
Example Request:
http://<device-ip>/bha-api/favorites.cgi?
action=remove&type=sip&id=2
Return:
HTTP/1.0 200 OK\r\n
\r\n
HTTP status codes:
V5=
DV!&
DV :
HV"
Copyright © 2023 by Bird Home Automation GmbH
SCHEDULE MANAGEMENT
@&,#
")&&,+,
)&$!,4"!+'','
!"%/0)+,/-0
/'*%0)&&'*%+
/50%,&&9
&,%E&&
/2-0V&-&
GB;73
4/'*%04&
4%E*6'*%DBGG )B
%YDYYV+D%
DC)C+&",
&C4
,'%&
7/0/0DBGG&%'
''*)'%+
%%%,
1I$!&&&CE*#4"!
",-
&1%,'&&
/ !"0&
2' & : % #8#.
Hint /&0& & &
LIST SCHEDULES
(%&&S45
Method: .1
Required permission:, !"
Syntax:
http://<device-ip>/bha-api/schedule.cgi
S45I
S45
>
TTT& %,&
Copyright © 2023 by Bird Home Automation GmbH
N-
OTNOTN-OT
N&-O
!,&
,2",&
S45% S45%&
S45I/0&
S45
>
%TT%T &$!
&&%
%/%0&&
&
NOTN--OTN%-OT
N--O
!&,&
)+%
%
T-T'*% 4&,&&&I,
&&&,&&
'*%
Example Request:
http://<device-ip>/bha-api/schedule.cgi
Return:
HTTP/1.0 200 OK\r\n
\r\n
[
{
"input":"doorbell", <!-- example for doorbell events -->
"param":"1", <!-- doorbell number 1 -->
"output":[
{
"event":"http",
"param":"1", <!-- trigger http favorite #1 -->
"schedule":{
"weekdays":[
{
"from":"122400", <!-- each Monday 10:00 – 18:00 UTC -->
"to":"151199"
}
]
}
}
]
},
{
"input":"motion", <!-- example for motion events -->
"param":"", <!-- no param for motion input -->
"output":[
{
"event":"relay",
"param":"2", <!-- trigger relay #2 -->
"schedule":{
"from-to":[
{
Copyright © 2023 by Bird Home Automation GmbH D
"from":"1509526800", <!-- 1.11.2017 10:00 UTC -->
"to":"1509555600" <!-- 1.11.2017 18:00 UTC -->
},
{
"from":"1509613200", <!-- 2.11.2017 10:00 UTC -->
"to":"1509642000" <!-- 2.11.2017 18:00 UTC -->
}
]
}
}
]
}
]
HTTP status codes:
V5=
DV:)/0:+
DV :
ADD OR UPDATE SCHEDULE ENTRY
&%&&S45I5
:%)&00/MBCG0+:
Method:!54
Required permission:, !"
Syntax:
http://<device-ip>/bha-api/schedule.cgi
Example Request:
http://<device-ip>/bha-api/schedule.cgi
Example JSON content for doorbell events:
{
"input": "doorbell",
"param": "1", <!-- configuration for doorbell #1 -->
"output": [{
"event": "notify", <!-- send notifications (push, history) -->
"param": "",
"enabled": "1",
"schedule": {
"weekdays": [{
"to": "82799",
"from": "82800"
}]
}
}, {
"event": "http",
"param": "3", <!-- trigger http favorite #3 -->
"enabled": "1",
"schedule": {
"weekdays": [{ <!--always trigger -->
"to": "82799",
"from": "82800"
}]
Copyright © 2023 by Bird Home Automation GmbH H
}
}]
}
Example JSON content for motion events:
{
"input": "motion",
"param": "",
"output": [{
"event": "notify",
"param": "",
"enabled": "1",
"schedule": {
"weekdays": [{ <!--always trigger -->
"to": "82799",
"from": "82800"
}]
}
}, {
"event": "relay",
"param": "1",
"enabled": "1",
"schedule": { <!--always trigger -->
"weekdays": [{
"to": "82799",
"from": "82800"
}]
},
}]
}
Return:
HTTP/1.0 200 OK\r\n
\r\n
HTTP status codes:
V5=
DV %S45<3-(&&<3-(&;<
;&
DV :
HV
HBV4;)%&
DELETE SCHEDULE ENTRY
%
Method: .1
Required permission:, !"
Syntax:
http://<device-ip>/bha-
api/schedule.cgi?action=remove&<parameter>=<value>
Copyright © 2023 by Bird Home Automation GmbH
NOQNO >
QN&O 2
&
%
QN&OTT TT
%,&
QN&O N-OTNOT
N-O
"
%
,&
,2"
Example Request:
http://<device-ip>/bha-api/schedule.cgi?
action=remove&input=motion¶m=xxx
Return:
HTTP/1.0 200 OK\r\n
\r\n
HTTP status codes:
V5=
DV :
HV
Copyright © 2023 by Bird Home Automation GmbH B
RESTART
'&)&/%
0+
Method: .1
Required permission:, !"
Syntax:
http://<device-ip>/bha-api/restart.cgi
Example Request:
http://<deviceip>/bha-api/restart.cgi
Return:
HTTP/1.0 200 OK\r\n
\r\n
HTTP status codes:
V5=
DV :
HV%)&%&'+
EVENT MONITORING (UDP BROADCASTS)
Since November 2023 there is a new “v.2” handling for encrypting/decrypting
the events. The version 1 has been deprecated and will be removed in the
future. It can also be disabled by the user in the administration area of the app.
"&'&
' % % & & '
&&/ &0&&'
16&
,#7!-#
HDHDD%%9
*&'*&,
%'%!,'&
* %B ' , *
%,%*
7! * , & 33
" '-*' 4 % %
)+
First Part:
2 (&#% % 1
"1 #% %**&
Copyright © 2023 by Bird Home Automation GmbH C
%
"1Z[Q1
"1Z[Q
"1Z[Q#1
>14"5 #% >14"52&'&
'%*&
%&'''&
%
Vdeprecated-33-!%H'
&
V33-!%H
Second Part for a package in VERSION 0x02:
2 (&#% % 1
531 C #% 7%'33-!%H
3"!$11A DY #% @33-!%H%'
1
Y%3"!$11A%',%
&%
The CIPHERTEXT after decryption:
2 (&#% % 1
"1356F" 4& &9
&*,'E%
#+
1>1 C 4& 3\/'
'&&!'
"614 6! D (& 7,&
Used Algorithms:
> 2
33-!%H 1%
Copyright © 2023 by Bird Home Automation GmbH G
Step by step example:
Step 1: %)'&+
:*%'%&"%
&&&:'
Syntax:
http://<device-ip>/bha-api/getsession.cgi
Return:
HTTP/1.1 200 OK
Content-Type: application/json
{ "BHA": {
"RETURNCODE": "1",
"SESSIONID":
"ISXA9dzpUfPUSlRNfufdOgGDWRy9WadbtXtB45v9YFc3jMLf4yR50a37gak9f",
"NOTIFICATION_ENCRYPTION_KEY":
"BHYGHyRKtGzBjku2t2jX2UKidXYQ3VqmfbKoCtxXJ6O4lgSzpgIwZ6onrSh"
}
}
*%/5"2"3 "5F139!"5F=190
%7!**%
'&,':&
So this request needs to be done only once and should not be
done for each received packet.
Notice: &/5"2"3 "5F139!"5F=190-D%
&'%&233%
#%*%' %'&%33
&
Step 29'&*7!
0xDE 0xAD 0xBE 0x02 0x96 0x13 0x80 0xD4 0x62 0x2E 0xBE 0xE7 0x2A 0x9F 0xC3 0xFF 0x0B
0xEF 0x62 0x64 0xF2 0xAE 0x91 0x94 0x92 0x14 0x8B 0xBD 0x30 0xEB 0x05 0xBD 0xCE 0x36
0x7C 0x33 0xD4 0x29 0x3F 0xAF 0xE0 0x60 0x45 0x9E 0x65 0x10
Step 34
2 3
"1
0xDE 0xAD 0xBE
>14"5
0x02
531
0x96 0x13 0x80 0xD4 0x62 0x2E 0xBE 0xE7
3"!$11A
0x2A 0x9F 0xC3 0xFF 0x0B 0xEF 0x62 0x64 0xF2 0xAE 0x91 0x94
0x92 0x14 0x8B 0xBD 0x30 0xEB 0x05 0xBD 0xCE 0x36 0x7C 0x33
0xD4 0x29 0x3F 0xAF 0xE0 0x60 0x45 0x9E 0x65 0x10
Step 4%3"!$11A'33-!%H,'%
Copyright © 2023 by Bird Home Automation GmbH
&&,
0x67 0x68 0x69 0x6B 0x7A 0x69 0x31 0x20 0x20 0x20 0x20 0x20 0x20 0x20 0x65 0x4D 0x13
0x51
Step 54
2 #%> >
"1356F"
0x67 0x68 0x69 0x6B 0x7A 0x69
\&*;/
4&4*
*,E%#
+
1>1
0x31 0x20 0x20 0x20 0x20 0x20
0x20 0x20
\/
)
,'+
"614 6!
0x65 0x4D 0x13 0x51
GGHH
%,GBH73
EXAMPLE SOURCE CODE
'&-'&&"
',,%
Decryption:
NotifyBroadcastCiphertext decryptBroadcastNotification(const NotifyBroadcast* notification, const Password*
password) {
NotifyBroadcastCiphertext decrypted = {{0},{0},0};
if(crypto_aead_chacha20poly1305_decrypt((unsigned char*)&decrypted, NULL, NULL, notification->ciphertext,
sizeof(notification->ciphertext), NULL, 0, notification->nonce, password->key)!=0){
LOGGING("crypto_aead_chacha20poly1305_decrypt() failed");
}
return decrypted;
}
Copyright © 2023 by Bird Home Automation GmbH
RTSP INTERFACE DESCRIPTION
LIVE VIDEO REQUEST
6!1.D $D '
%&74!HHD
4!--$! CHHB # #.
&&-% !",&
'*:4!
)'$!+
@:,:&'
,:''D
%'/'-'%0''&
H
!,4!&%,'
# :"( -
!"
Method: .1
Required permission:,/''%0&H:&
Syntax:
rtsp://<device-ip>:<device-rtsp-port>/mpeg/media.amp
rtsp://<device-ip>:<device-rtsp-port>/mpeg/720p/media.amp *
rtsp://<device-ip>:<device-rtsp-port>/mpeg/1080p/media.amp **
Example Request:
rtsp://<device-ip>:8557/mpeg/media.amp
rtsp://<device-ip>/mpeg/media.amp
rtsp://<device-ip>/mpeg/1080p/media.amp
)Y+%#>482'->G
)YY+%#>4%
Copyright © 2023 by Bird Home Automation GmbH
Session Initiated Protocol (SIP)
SIP
&4"!'
4"!%&,'&
4"!&'%1%'
'4"!8&&
98''/ !"0
)# J J7J1J!+
*)4"!+%
4"!&
14"!C',%
)-&+
4"!'%'
,%)
( !"+'?*??&?
%4"!
"624)4"!+&&
%%&%
6*&8&*',4"!
*%;,4"!
@&&&"&'*&,'H-B
"],
*''%&)'*,4"!!%,&+
]'%4"!:,'
'4"!:
!% 13) 13+-
' 3) 3+&:%
Copyright © 2023 by Bird Home Automation GmbH
'%&&4"!,8*
:#
2GG,--)!!+4"!
&4"!%'/Q0,%
4"!H&&,
/Q*0&&&
/FF0
SIP Registration
&4"!!%%,%&--
Method: .1
Required permission:,/ !"0
Syntax:
http://<device-ip>/bha-api/sip.cgi?
action=registration&user=<user>&password=<password>&url=<url>
NOQNO
QN4&O 4"!!%
'QN4&O '4"!!%
QN4&O "!8$4"!!%
Example "registration" Request:
http://<deviceip>/bha-api/sip.cgi?
action=registration&user=foo&password=bar&url=192.168.123.22
Returns:
%&*%
D)8'# '&/ !"0+
SIP Make Call
6%4"!--/04"!
&&!#A84"!%
Method: .1
Required permission:,/ !"0
Syntax:
http://<device-ip>/bha-api/sip.cgi?action=makecall&url=<url>
NOQNO
QN4&O 4"!7(
Example "makecall" Request:
http://<deviceip>/bha-api/sip.cgi?
action=makecall&url=sip:[email protected]
Copyright © 2023 by Bird Home Automation GmbH D
Returns:
%&*
D&'&,&&
D)8'# '&/ !"0+
H'*,&%
SIP Hangup
$&4"!"%&&,3."/5=0
Method: .1
Syntax:
http://<device-ip>/bha-api/sip.cgi?action=hangup
Returns:
%&*
D)8'# '&/ !"0+
SIP Settings (CGI)
3&4"!&
"autocall_doorbell_url&
'"&%&)&'
&+,%)&
&+3%&FF&&
% ' &
%
Method: .1
Required permission:,/ !"0
Syntax:
http://<device-ip>/bha-api/sip.cgi?action=settings&<parameter>=<value>
NOQNO >
QN"&O 14"!&
,
FQN"&O 4,
*FQN"&O 4*,B
QN"&O 162,
FFQN4&O 7(
??
DEPRECATED: use schedule.cgi
4"!7(%
#%
&
Copyright © 2023 by Bird Home Automation GmbH H
4??
??
%FQN"&O GGGGGGGG !&&&
%
&FFQN"O 1&,
&FFQN4&O 4"! '4"!''
#1&
/H/
/UH/
QN"&O 1
,
&FFQN"&O 4&&
,
FFQN"&O 4
,
Example "settings" Request:
http://<deviceip>/bha-api/sip.cgi?
action=settings&autocall_doorbell_url=sip:[email protected]
Returns:
%&*%
D)8'# '&/ !"0+
SIP Status
9:%4"!%&'&7(
Method: .1
Required permission:,/ !"0
Syntax:
http://<device-ip>/bha-api/sip.cgi?action=status
Returns:
S45,'^?( 415351???]4"!%&( 415351
4"!?( 4151A?4"!
%&*%
D)8'# '&/ !"0+
SIP Settings Reset
4"!&,_&4"!%&
)Q&+4"!&)Q&+$&%&&
Method: .1
Required permission:,/ !"0
Syntax:
http://<device-ip>/bha-api/sip.cgi?action=reset
Returns:
Copyright © 2023 by Bird Home Automation GmbH
S45,'^( 415351???]4"!%&( 415351
4"!/( 4151A04"!
%&*%
D)8'# '&/ !"0+
SIP Settings (DoorBird App)
# &4"!%
(&%#' )&`+,
'/14&0'%/4"!4&0
%4"!%&
4"!)H+,%%/4"!
!%0,',&GGGG
Example SIP settings inside the DoorBird App:
Copyright © 2023 by Bird Home Automation GmbH B
