/
4.1.13.1 Conference

4.1.13.1 Conference

Owned by Tomasz Kozierowski
Last updated: Jun 24, 2024

GET /groupchat/{groupId}/conference/status

Description

The method returns the status of users from the conference server.

Parameters

NameLocated inDescriptionRequiredExample
AuthorizationheaderBasic authorization. SIP login and SIP password requiredyesBasic aHR0cHdhdGNoOmY=
User-AgentheaderDialer identifier in the form custom-name,operating-system,application-versionyesvippie;ios;2.1.9
groupIdpathID of group chat to fetch conference statusyesunsigned integer

Responses

CodeDescriptionSchema
200telepresence status response
{
 "gm": [
  {"l": "1000005", "a": 1, "v": 0},
  {"l": "1000001", "a": 1, "v": 1}
 ],
 "gg": [
  {"l": "48500200300", "a": 1, "v": 0},
  {"l": "48600300400", "a": 1, "v": 0}
 ]
}

where:

  • gm - list of group participants,
  • gg - group guest list,
  • l - group participant login,
  • a -audio status, can take values 0 or 1,
  • b - video status, can take values 0 or 1.
400bad request - request could not be understood by the server
403forbidden
404not found
500internal server error


All status change notifications will be sent from EMCD via SIP INFO. Content example:

{
 "action": "conference-status",
 "status": 200,
 "gid"   : 383,
 "login" : "123728362",
 "guest" : "48500100200",
 "audio" : 1,
 "video" : 0
}
SIP/2.0 200 OK
Via: SIP/2.0/UDP 192.168.1.230:10066;branch=u2aG4bC-26676-2-6
From: <sip:system@hstsrv.net>;tag=1
To: <sip:123728362@hstsrv.net>;tag=31051470601
Call-ID: 1-24086@192.168.1.230
CSeq: 1 INFO
Content-Length: 89
Content-Type: text/plain
{"action": "conference-status", "gid": 383, "login": "123728362", "audio": 1, "video": 0}

POST /groupchat/{groupId}/conference/invite

Description

Invitation to the conference.

Parameters

NameLocated inDescriptionRequiredExample
AuthorizationheaderBasic authorization. SIP login and SIP password requiredyesBasic aHR0cHdhdGNoOmY=
User-AgentheaderDialer identifier in the form custom-name,operating-system,application-versionyesvippie;ios;2.1.9
groupIdpathID of group chat to fetch conference statusyesunsigned integer
bodybody
yes
{
 "gm": [
  {"l": "login1"}
 ],
 "gg": [
  {"l": "48500100300"}
 ]
}

Responses

CodeDescriptionSchema
200OK
 
{
 "gm": [
  {"l": "login1", "pid": "CC.de1d183f-ad3f-40d0-8322-c54b5be3b2ec"}
 ],
 "gg": [
  {"l": "48500100300", "pid": "CC.de1d183f-ad3f-40d0-8322-c54b5be3b2ec"}
 ]
}

where:

  • gm - participants login
  • gg - number of guests
  • l - login
  • pid - process ID.
400bad request - request could not be understood by the server
403forbidden
404not found
500internal server error


Call status notifications will be sent from EMCD via SIP INFO. Content example:

{
 "action": "conference-status",
 "status": 180,
 "gid"   : 383,
 "login" : "login",
 "guest" : "number"
}

where:

  • gid - group ID
  • login - sip login. optional parameter.
  • quest - telephone number  -group chat guest 
  • status - connection status - 100 = trying, 486 = busy, 487 = terminated
Przyk?ad
SIP/2.0 200 OK
Via: SIP/2.0/UDP 192.168.1.230:10066;branch=u2aG4bC-26676-2-6
From: <sip:system@hstsrv.net>;tag=1
To: <sip:123728362@hstsrv.net>;tag=31051470601
Call-ID: 1-24086@192.168.1.230
CSeq: 1 INFO
Content-Length: 89
Content-Type: text/plain
{"action": "conference-status", "status": 100, "gid": 383, "login": "123728362"}

PATCH /groupchat/{groupId}/conference/invite

Description

Cancel an invitation.

Parameters

NameLocated inDescriptionRequiredExample
AuthorizationheaderBasic authorization. SIP login and SIP password requiredyesBasic aHR0cHdhdGNoOmY=
User-AgentheaderDialer identifier in the form custom-name,operating-system,application-versionyesvippie;ios;2.1.9
groupIdpathID of group chat to fetch conference statusyesunsigned integer
bodybody
yes
[
 {"pid": "64ba48ea-a5b1-41b8-a533-1b6a0e51ddcf"},
 {"pid": "ce5e1f98-68c8-46d3-80c8-45b1859d43ee"}
}

where:

  • pid - process ID.

Responses

CodeDescriptionSchema
200OK
400bad request - request could not be understood by the server
403forbidden
404not found
500internal server error