Web API Specification Sheet for the TS-D1000 Wired Conference System

Conference mode acquisition

GET/api/talkreq-mode

Acquires the conference mode setting status when in centralized control mode.

Example URI

Content-Type: application/json

{
  "request": true
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "request": {
      "type": "boolean",
      "description": "Speech request setting(true:Allowing speech request, false:Prohibiting speech request)"
    }
  }
}

In-use conference unit ID acquisition

GET/api/conf-talkunit

Acquires ID of currently in-use conference unit(s).
The maximum number of simultaneously “in-use” conference units shall be limited to 10 units.

Example URI

Content-Type: application/json

{
  "unitid": [
    {
      "id": 1
    }
  ]
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "unitid": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "In-use conference unit ID"
          }
        }
      },
      "description": "List of conference unit ID"
    }
  }
}

Speech requesting conference unit ID acquisition

GET/api/conf-requestunit

Acquires the ID of conference unit(s) currently requesting speech authorization.
The maximum number of conference units simultaneously requesting speech authorization shall be limited to 10 units.

Example URI

Content-Type: application/json

{
  "unitid": [
    {
      "id": 1
    }
  ]
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "unitid": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "ID of conference unit that requesting speech"
          }
        }
      },
      "description": "List of conference unit ID"
    }
  }
}

Monitor speaker volume acquisition

GET/api/monitorsp-vol

Example URI

Content-Type: application/json

{
  "monitorsp-vol": "mute"
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "monitorsp-vol": {
      "type": "string",
      "enum": [
        "mute",
        "-20",
        "-18",
        "-16",
        "-14",
        "-12",
        "-10",
        "-8",
        "-6",
        "-4",
        "-2",
        "0",
        "+2",
        "+4",
        "+6",
        "+8"
      ],
      "description": "Volume adjustment value(mute,-20dB to +8dB)"
    }
  }
}

Monitor speaker setting information acquisition

GET/api/monitorsp-inuse

Example URI

Content-Type: application/json

{
  "monitorsp-inuse": true
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "monitorsp-inuse": {
      "type": "boolean",
      "description": "Monitar speaker ON/OFF(true:ON,false:OFF)"
    }
  }
}

Recording status acquisition

GET/api/rec

Acquires the TS-D1000MU’s recording status.

Example URI

Content-Type: application/json

{
  "status": "rec"
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "rec",
        "idle"
      ],
      "description": "Recording status"
    }
  }
}

Conference unit ID acquisition

GET/api/conf-unit

Acquires the conference unit ID detected by the TS-D1000MU Master Control Unit.

Example URI

Content-Type: application/json

{
  "unitid": [
    {
      "id": 1,
      "unittype": "delegate",
      "duplicate": true
    }
  ]
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "unitid": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "Conference unit ID"
          },
          "unittype": {
            "type": "string",
            "enum": [
              "delegate",
              "chairman"
            ],
            "description": "Unit type"
          },
          "duplicate": {
            "type": "boolean",
            "description": "Whether ID is dupulicated(true:Dupulicated, false:Not duplicated)"
          }
        }
      },
      "description": "List of conference unit"
    }
  }
}

Automatic ID setting results acquisition

GET/api/autoidset-result

Acquires the results of automatic ID setting.

Example URI

Content-Type: application/json

{
  "result": true
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "result": {
      "type": "boolean",
      "description": "Result of auto ID setting(ture:Successful completion, false:Failure detection)"
    }
  }
}

Connection test status acquisition

GET/api/connection-test

Acquires the status of whether the connection confirmation is being performed.

Example URI

Content-Type: application/json

{
  "status": "idle",
  "id": 1
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "idle",
        "all",
        "unit"
      ],
      "description": "Connection test status"
    },
    "id": {
      "type": "number",
      "description": "ID No. of conference unit(only for `unit`)"
    }
  }
}

Time acquisition

GET/api/time

Acquires time.

Example URI

Content-Type: application/json

{
  "time": "2018-12-31T00:00:00"
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "time": {
      "type": "string",
      "description": "Date and Time（ISO8601 format：YYYY-MM-DDThh:mm:ss）"
    }
  }
}

Receives status monitoring results.

GET/api/event

talkred-mode Event Specifications ¶

This event is utilized during setting change to the conference mode.

Shown below is a factor representing the occurrence of this event:
・When sending the Conference Mode API

Data field is as follows:

• request: true (boolean) - speech request approval flag settings (true: speech request approval system; false: full-control system)

request-talkreq Event Specifications ¶

Shown below are factors representing the occurrence of this event:
・Conference unit speech request
・Conference unit speech request cancellation

Data field is as follows:

• id: 1 (number) - Conference unit ID (1 – 246)

• status: add (enum[string]) - Speech request status change

  • add - Speech request
  • cancel - Speech cancellation

response-unitcancel Event Specifications ¶

This event is utilized by the external control device to cancel a speech request.
The external control device performs conference unit speech request cancellation, and software created based on this event specification provides notification of the results of the speech request cancellation.

Shown below is a factor representing the occurrence of this event:
・When sending Basic Conference Operation Control API cancellation of individual conference unit speech request.

Data field is as follows:

• id: 1 (number) - ID No. of conference unit（1-246）

• status: success (enum[string]) - Speech request cancellation processing results

  • success - Speech request cancellation completed
  • failed - Speech request cancellation failed (details unknown)
  • failed-outrange - Speech request cancellation failed (invalid CU/DU ID)
  • failed-noneduid - Speech request cancellation failed (CU/DU of the ID is not connected)

response-unitstart Event Specifications ¶

This event is utilized by the external control device to start speech.
The external device initiates conference unit speech start, and software created based on this event specification provides notification of the results of the speech start.

Shown below is a factor representing the occurrence of this event:
・ When sending Basic Conference Operation Control API to start conference unit speech.

Data field is as follows:

• id: 1 (number) - Conference unit ID (1 – 246)

• status: success (enum[string]) - Speech start processing results

  • success - Speech start completed
  • failed - Speech start failed (details unknown)
  • failed-outrange - Speech start failed (invalid CU/DU ID)
  • failed-noneduid - Speech start failed (CU/DU of the ID is not connected)
  • failed-maxmicunit - Speech start failed (units in use exceed max. number)
  • failed-modeerror - Speech start failed (invalid system status)

response-unitstop Event Specifications ¶

This event is utilized by the external control device to stop conference unit speech.
The external control device performs conference unit speech stop and software created based on this event specification provides notification of the results of the speech termination.

Shown below is a factor representing the occurrence of this event:
・When sending Basic Conference Operation Control API to stop conference unit speech.

Data field is as follows:

• id: 1 (number) - Conference unit ID (1 – 246)

• status: success (enum[string]) - Speech stop processing results

  • success - Speech stop completed
  • failed - Speech stop failed (details unknown)
  • failed-outrange - Speech stop failed (Invalid CU/DU ID)
  • failed-noneduid - Speech stop failed (CU/DU of the ID is not connected)

response-allcancel Event Specifications ¶

This event is utilized by the external control device to simultaneously cancel speech requesting party lists.
The external control device performs simultaneous cancellation of speech requesting party lists to conference units and software created based on this event specification provides notification of the results of the list cancellation.

Shown below is a factor representing the occurrence of this event:
・When sending Basic Conference Operation Control API to simultaneously cancel all conference unit’s speech request.

Data field is as follows:

• status: success (enum[string]) - Results of speech requesting party list cancellation processing
  • success - Simultaneous speech requesting party list cancellation completed
  • failed - Simultaneous speech requesting party list cancellation failed (details unknown)

response-alltstop Event Specifications ¶

This event is utilized by the external control device to simultaneously stop all unit speeches.
The external control device performs simultaneous stop of all conference unit speeches and software created based on this event specification provides notification of the results of the simultaneous cancellation.

Shown below is a factor representing the occurrence of this event:
・When sending Basic Conference Operation Control API to simultaneously stop all conference unit speech.

Data field is as follows:

• status: success (enum[string]) - Results of speech stop processing
  • success - Simultaneous speech stop of all speakers in the list completed
  • failed - Simultaneous speech stop of all speakers in the list failed (details unknown)

notify-allcancel Event Specifications ¶

This event is utilized when simultaneously canceling all conference unit speech requests.
No data field.

Shown below is a factor representing the occurrence of this event:
・When switching to a mode that does not allow approval of speech requests due to system mode changes (connection confirmation or automatic ID settings)

notify-alltstop Event Specifications ¶

This event is utilized when a simultaneous speech stop signal is received from a conference unit.
No data field.

Shown below is a factor representing the occurrence of this event:
・When switching to a mode that does not allow approval of speech requests due to system mode changes (connection confirmation or automatic ID settings)

rec Event Specifications ¶

Recording-related status notifications.

Factors representing the occurrence of this event are as follows:
・When sending Recordings API start signal.
・When sending Recordings API stop signal.
・When a USB flash memory is inserted.
・When a USB flash memory is removed.
・When the remaining capacity of the USB flash memory changes. (remaining capacity available → remaining capacity warning)
・When the remaining capacity of the USB flash memory changes. (remaining capacity warning → remaining capacity available)
・When the remaining capacity of the USB flash memory changes. (remaining capacity warning → recording data overload)
・When the remaining capacity of the USB flash memory changes. (recording data overload → remaining capacity warning)
・When the remaining capacity of the internal memory changes. (remaining capacity available → remaining capacity warning)
・When the remaining capacity of the internal memory changes. (remaining capacity warning → remaining capacity available)
・When the remaining capacity of the internal memory changes. (remaining capacity warning → recording data overload)
・When the remaining capacity of the internal memory changes. (recording data overload → remaining capacity warning)

Data field is as follows:

• status: recstart (enum[string]) - Recording information
  • recstart - Recording start
  • recstop - Recording stop
  • usbmount - USB mount(inserted)
  • usbunmount - USB unmount(removed)
  • usbmemwarning - USB flash memory remaining capacity warning
  • usbmemfull - USB flash memory recording data overload
  • usbmemenough - USB flash memory remaining capacity available
  • usbmemerror - USB flash memory irregularity notification
  • internalmemwarning - Internal memory remaining capacity warning
  • internalmemfull - Internal memory recording data overload
  • internalmemenough - Internal memory remaining capacity available
  • internalmemerror - Internal memory irregularity notification

notify-autoiddetection Event Specifications ¶

This event is utilized when a conference unit’s connection status is changed at the conference unit.

Factors representing the occurrence of this event are as follows:
・When a Conference Unit ID API ID reassignment is sent.
・When a conference unit is connected.
・When a conference unit is disconnected.

Data field is as follow:

• status: resetid (enum[string]) - Conference unit connection status change
  • resetid - Start of ID reassignment
  • unitconnect - Connection of additional conference units (after ID setting is completed)
  • unitdisconnect - Conference unit disconnection (after ID setting is completed)

autoidset-complete Event Specifications ¶

Notification of this event is provided when the automatic ID setting of a conference unit is completed.

The factor representing the occurrence of this event is as follows:
・When a Conference Unit ID API ID reassignment is sent and the automatic ID setting is completed.

No data field.

notify-testunit Event Specifications ¶

This event is utilized when a confirmation ID is changed at the time of connection confirmation (ID designation mode).

The factor representing the occurrence of this event is as follows:
・When sending Connection Test API to start individual conference unit connection test.

Data field is as follows:

• id: 1 (number) - Conference unit ID (1 – 246)

time Event Specifications ¶

Notifications relating to status of data and time are sent.
No data field.

The factor representing the the occurrence of this event is as follows:
・When sending Time API time settings.

system Event Specifications ¶

Notifications relating to status of system mode are sent.

Factors representing the occurrence of this event are as follows:
・When sending Connection Test API to start connection confirmation.
・When sending Connection Test API to start individual conference unit connection confirmation.
・When sending Conference Unit ID API ID reassignment.
・When turning off the TS-D1000MU Master Control Unit’s power.
・When the TS-D1000MU Master Control Unit’s Power OFF button is pressed.
・When performing automatic ID settings.

Data field is as follows:

• mode: normal (enum[string]) - System event
  • normal - Normal condition
  • autoidset - Automatic ID setting status
  • testall - Connection confirmation mode all DUs
  • testunit - Individual connection confirmation mode designation
  • shutdown - Shutdown
  • reboot - Restart
    

Example URI

Content-Type: text/event-stream
Transfer-Encoding: chunked

event: talkreq-mode<\n>
data: [{"request":true}]<\n>
<\n>
event: request-talkreq<\n>
<\n>
data: [{"id":1, "status":"add"}]<\n>
<\n>
event: response-unitcancel<\n>
data: [{"id":1, "status":"success"}]<\n>
<\n>
event: response-unitstart<\n>
data: [{"id":1, "status":"success"}]<\n>
<\n>
event: response-unitstop<\n>
data: [{"id":1, "status":"success"}]<\n>
<\n>
event: response-allcancel<\n>
data: [{"status":"success"}]<\n>
<\n>
event: response-allstop<\n>
data: [{"status":"success"}]<\n>
<\n>
event: notify-allcancel<\n>
<\n>
event: notify-allstop<\n>
<\n>
event: rec<\n>
data: [{"status":"recstart" }]<\n>
<\n>
event: notify-autoiddetection<\n>
data: [{"status":"resetid"}]<\n>
<\n>
event:autoidset-complete<\n>
<\n>
event:notify-testunit<\n>
data: [{"id":1}]<\n>
<\n>
event: time<\n>
<\n>
event: system<\n>
data: [{"mode":"normal" }]<\n>
<\n>