API referenceVideo conference

Add conference event

POSThttps://demo-api.incodesmile.com/omni/conference/add/event

Send (OpenTok) conference event. Any connection issue caught by webapp could be reported using this call.

Headers

api-versionstringrequiredDefaults to 1.0

Request body

application/json

get_versioninteger (int64)

interviewIdstringrequired

Interview ID for which event is reported.

opentokSessionIdstringrequired

Opentok session ID of current video conference.

eventTypestringrequired

Opentok event type. Could be anything that Opentok sends, e.g. StreamDisconnected, StreamReconnected, VideoDisabled, VideoEnabled...

detailsstring

Any description that Opentok sends.

eventSourcestringrequired

Indicate event caught on customer or executive side.

enumcustomerexecutive

Responses

Language

Credentials

x-api-key

X-Incode-Hardware-Id

api-version

Stored only in your browser — sent straight to the Incode demo API, never to this site.

Request

curl -X POST https://demo-api.incodesmile.com/omni/conference/add/event \  -H "x-api-key: <YOUR_API_KEY>" \  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \  -H "api-version: 1.0" \  -H "Content-Type: application/json" \  -d '{    "interviewId": "<interviewId>",    "opentokSessionId": "<opentokSessionId>",    "eventType": "<eventType>",    "eventSource": "<eventSource>"  }'

Fill the fields on the left to build the request.

Response

Click Try It ▶ to send a request and see the response here. Or choose an example:

application/json

Updated yesterday

Was this page helpful?