1. 개요

1.1.용도

주요 용도는 회의 창설과 참여를 인증하는 것이다.

1.2.적용 버전

대충

1.3.통신 프로토콜

본 규범에서 업무 시스템은 통신의 서버 측(약칭'서버')이고 신호 서버는 통신 클라이언트(약칭'클라이언트')이다.클라이언트와 서버는 HTTP 프로토콜을 통해 통신하고 클라이언트는 HTTP Get 또는 HTTP Post 서버로 요청을 보내며 서버는 json 형식의 업무 데이터나 작업 결과를 클라이언트에게 되돌려줍니다.

1.4.인터페이스 요청

HTTP Get 또는 POST

1.5.인터페이스 응답

서버는 json 형식의 텍스트 내용을 클라이언트에게 되돌려줍니다.클라이언트에게 되돌아오는 json 텍스트는 서버가 요청한 처리 결과와 응답 데이터를 설명합니다.

1.6.인터페이스 보안

업무 서버는 명령 서버에서 보낸 요청만 받아들인다.

1.7.URL 인코딩

URL 요청 매개 변수 값에 URL 주소 보존 문자가 포함되어 있을 때 매개 변수 값을 URL 인코딩해야 합니다.구체적으로 "RFC2396: Uniform Resource Identifiers(URI): Generic Syntax"를 참조하십시오.요청 매개 변수에 중국어 문자가 포함되어 있으면 중국어 문자는 UTF-8 인코딩을 사용해야 합니다.

1.8.메시지 구조 되돌리기

되돌아오는 json 메시지 데이터 구조는 엄격한 일치성을 가지고 클라이언트는 일치된 수신과 해석 방식으로 되돌아오는 메시지를 처리할 수 있다.간단한 메시지 간단한 반환 메시지는 다음과 같은 구조로 요청에 대한 처리 결과를 포함합니다.

{
    "code":0,
    "err_desc":""
}

여기에서: 코드는 0으로 처리가 성공했고, 다른 값은 처리가 실패했음을 나타냅니다.err_desc는 오류에 대한 설명입니다. 코드가 0일 때err_desc는 생략됩니다.

2. 인터페이스 매개변수

[필수 매개 변수] 룸 번호, 문자열 8 ~ 16자입니다.peer 참조 사용자의 고유 번호, 1~32자입니다.신호 서버는 같은 의미를 가진 방 번호와 사용자 번호를 이 두 개의 매개 변수로 비추어 인터페이스에 전달해야 한다.
[선택 가능한 매개 변수]acct 사용자 계정, 업무 시스템 제공.pwd 사용자 비밀번호, 업무 시스템 제공.name 사용자의 표현 이름, 출처는 필요에 따라 설정되며, 익명 로그인은 읽을 수 있는 이름을 필요로 할 수 있습니다.
이 세 가지 파라미터는 업무 시스템에서 신호 서버에 제출하고 신호 서버는 인터페이스에 전송된다.

3. 인터페이스 정의

3.1.회의 열기 / 회의 만들기(옵션 인터페이스)

요청하다

    /meeting/open/?room=aaabbb&peer=peerIdOrName&acct=xxx&pwd=xxx&name=xxx

응답

    ```
    {
        "code":0,
        "err_desc":""
    }
    ```

코드가 0이 아니면 만들 수 없습니다.일반적으로 업무 차원에서 주관 권한이 있는 사람이 회의를 만든다.

3.2.회의 닫기(인터페이스 옵션)

요청하다

    /meeting/close/?room=aaabbb&peer=peerIdOrName

응답

    ```
    {
        "code":0,
        "err_desc":""
    }
    ```

코드가 0이 아닌 경우 처리가 실패했습니다. 주관 권한이 없기 때문일 수 있습니다.

3.3.회의 참여(필수 인터페이스)

요청하다

    /meeting/jion/?room=aaabbb&peer=peerIdOrName&acct=xxx&pwd=xxx&name=xxx

응답

    ```
    {
        "code":0,
        "err_desc":""
    }
    ```

코드가 0이 아니면 입회가 허용되지 않습니다.

3.3.회의 종료 (필수 인터페이스)

요청하다

    /meeting/leave/?room=aaabbb&peer=peerIdOrName

응답

    ```
    {
        "code":0,
        "err_desc":""
    }
    ```