Skip to main content

Group Call Event callback

When a participant joins or leaves a group call (conference), the Group Call Event callback is called. Applications can do the following tasks with the Group Call Event callback.

Notify participants that the call has just started
Check the call status (for example, whether the group call ended or not)
Collect statistical data

Method and URI

Method: GET
URI: {on_gcall_evt_cb_url}

Query parameters

Parameter	Type	Nullable	Description	Example
`sid`	String	N	Session ID. You can identify a call using a `sid`. Fixed size of 32 bytes without NULL.	`6364e8b3bdac436e96310bce2498ce0c`
`svc_id`	String	N	Group call service ID	`room-service-id`
`id`	String	N	Group call ID	`room-id`
`user_svc_id`	String	N	Participant service ID	`user-service-id`
`user_id`	String	N	Participant user ID	`user-id`
`host_svc_id`	String	N	Host service ID	`host-service-id`
`host_id`	String	N	Host user ID	`host-user-id`
`sc`	String	N	Group call status code - `S`: Started - `C`: Changed - `E`: Ended	`S`
`setup_time`	Long	N	Time when this group call was made (seconds)	`0`
`start_time`	Long	N	Time when this group call started (seconds)	`0`
`end_time`	Long	N	Time when this group call ended (seconds)	`0`
`online`	Integer	N	The number of online participants (connected participants)	`0`
`media_type`	String	N	Media type - `A`: Audio group call - `V`: Video group call	`A`
`msc`	String	N	Participants status code - `C`: Connected - `D`: Disconnected - `T`: Timeout - `M`: Media changed	`C`
`stid`	String	Y	Deprecated. Application data delivered from `joinConference()` in PlanetKit SDK	`application-data`
`ts`	Numeric	N	Timestamp in milliseconds	`2277272`
`rel_code`	Integer	Y	Detailed release code of a call. This is used to track the call release reason in the platform. Refer to Call release reason.	`1`
`rel_code_str`	String	Y	Detailed release code of a call. This is used to track the call release reason in the platform. Refer to Call release reason.	`NORMAL`
`ue_type`	String	N	Type of the user equipment - `UE_TYPE_UNDEFINED` - `ANDROID` - `IOS` - `DESKTOPMAC` - `DESKTOPWIN` - `BROWSER` - `SIP_TERMINAL`	`IOS`
`display_name`	String	Y	Display name of the user equipment	`iosApp`
`client_address`	String	Y	Client's IP address	`1.1.1.1`
`mtg_data`	String	Y	Meeting data specified when creating a meeting	`JP`
`rc_idc`	String	Y	Represents the IDC of the group call server. All uppercase in the ISO 3166-1 alpha-2 code format.	`JP`
`disconnect_reason`	Integer	Y	Disconnect reason. For more information, see Disconnect reasons.	`1001`
`releaser_type`	Integer	Y	Type of the releaser (disconnect source). For more information, see Disconnect sources.	`1`
`app_svr_data`	String	Y	Application data delivered from `joinConference()` in PlanetKit SDK. For more information, refer to the app server data guide for each client platform: - Android - iOS/macOS - Windows - Web Note: This parameter delivers the same data as `stid`.	`generated-by-application`

Example

# Let's suppose on_gcall_evt_cb_url is
# http://sample.server.com:20200/gcall_event
# LINE Planet server will send a request to on_gcall_evt_cb_url as follows.

GET http://sample.server.com:20200/gcall_event?
sid=59db2167e13911ea83a8213945545d1c&
svc_id=room-service-id&
id=1111&
user_svc_id=user-service-id&
user_id=9286&
host_svc_id=host-service-id&
host_id=2809&
sc=C&
setup_time=1597744702514&
start_time=1597744703058&
end_time=0&
online=2&
mediaType=V&
msc=C&
stid=application-data&
ts=1599463610820&
ue_type=IOS&
display_name=iosApp&
client_address=1.1.1.1&
mtg_data=JP&
rc_idc=JP&
app_svr_data=appSvrData

Method and URI
Query parameters
Example