Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Видеокодеки: H.264, VP8
  • Аудиокодеки: G.711, Speex, Opus

Поддерживаемые кодеки на RTMP

...

REST-методы и статусы ответа

REST-метод

Пример тела REST-запроса

Пример тела REST-ответа

Статусы ответа

/call/startup

Code Block
languagejs
themeRDark
{
  "callId":"123456711",
  "callee":"10000",
  "toStream":"stream1",
  "rtmpUrl":"rtmp://localhost:1935/live/",
  "rtmpStream":"rtmp_stream1",
  "hasAudio":"true",
  "hasVideo":"true",
  "sipLogin":"10009",
  "sipAuthenticationName":"10009",
  "sipPassword":"1234",
  "sipDomain":"226.226.225.226",
  "sipOutboundProxy":"226.226.225.226",
  "sipPort":"5060",
  "appKey":"defaultApp",
  "sipRegisterRequired":"false"
}


200 - Звонок принят на обработку

409 - Конфликт с существующим RTMP URL

/call/find

Code Block
languagejs
themeRDark
{"status" : "ESTABLISHED"}

or

Code Block
languagejs
themeRDark
{"callId":"R08NQya-5NMe5v7q-JNkboaS-CGMlFi"}
Code Block
languagejs
themeRDark
[{
 "custom": {},
 "nodeId": null,
 "appKey": null,
 "sessionId": null,
 "callId": "R08NQya-5NMe5v7q-JNkboaS-CGMlFi",
 "parentCallId": null,
 "incoming": false,
 "status": "ESTABLISHED",
 "sipStatus": 200,
 "rtmpUrl": null,
 "rtmpStream": null,
 "streamName": null,
 "rtmpStreamStatus": null,
 "caller": "001",
 "callee": "002",
 "hasAudio": true,
 "hasVideo": false,
 "sdp": null,
 "visibleName": "001",
 "inviteParameters": null,
 "mediaProvider": "Flash",
 "sipMessageRaw": null,
 "isMsrp": false,
 "target": null,
 "holdForTransfer": false
}]

200 - звонок найден

404 - звонок с указанными параметрами не найден

/call/find_all


Code Block
languagejs
themeRDark
[{
 "custom": {},
 "nodeId": null,
 "appKey": null,
 "sessionId": null,
 "callId": "R08NQya-5NMe5v7q-JNkboaS-CGMlFi",
 "parentCallId": null,
 "incoming": false,
 "status": "ESTABLISHED",
 "sipStatus": 200,
 "rtmpUrl": null,
 "rtmpStream": null,
 "streamName": null,
 "rtmpStreamStatus": null,
 "caller": "001",
 "callee": "002",
 "hasAudio": true,
 "hasVideo": false,
 "sdp": null,
 "visibleName": "001",
 "inviteParameters": null,
 "mediaProvider": "Flash",
 "sipMessageRaw": null,
 "isMsrp": false,
 "target": null,
 "holdForTransfer": false
}]

200 - звонки найдены

404 - звонков не найдено

/call/terminate

Code Block
languagejs
themeRDark
{"callId" : "becee2c0-13b4-11e7-b817-c1649197cae8"}

200 - звонок прерван

404 - звонок не найден

/call/send_dtmf

Code Block
languagejs
themeRDark
{
 "callId" : "52173e00-13b6-11e7-b817-c1649197cae8",
 "dtmf":"9",
 "type":"RFC2833"
}

200 - DTMF отправлен

404 - звонок не найден

/call/inject_stream

Code Block
languagejs
themeRDark
{
 "callId": "ad5ac8a0-b518-11e7-82c7-999b45e427ba",
 "streamName": "mixer1_stream"
}
200 - аудиопоток добавлен к звонку

404 - звонок не найден

Параметры

Имя параметра

Описание

Пример

callId

SIP Call ID - уникальный идентификатор в виде строки

Xq2tlLcX89tTjaji

callee

SIP callee - вызываемый абонент

10001

toStream

Имя потока на WCS-сервере, в который транслируется звонок

call_stream1

rtmpUrl

RTMP URL - адрес RTMP-сервера

rtmp://rtmp-server.flashphoner.com:1935/live

Здесь live - имя RTMP-приложения.

В RTMP URL также могут быть указаны instance name и строка запроса, например

rtmp://rtmp-server.flashphoner.com:1935/live/_definst_?param1=value1&param2=value2

rtmpStream

Название RTMP-потока на RTMP-сервере

streamName2

hasAudio

Если true, SDP будет иметь 'sendrecv' параметр в аудио части. Если false, то 'recvonly'.

true

hasVideo

Если true, SDP будет иметь 'sendrecv' параметр в видео части. Если false, то 'recvonly'.

true

status

Статус звонка на WCS-сервере

ESTABLISHED


Полный список статусов доступен здесь (см CallStatusEvent).

sipStatus

Ассоциированный SIP-статус

200

rtmpStreamStatus

Статус RTMP-потока

RTMP_STREAM_ACTIVE

RTMP_STREAM_WAIT - RTMP-поток инициализируется

RTMP_STREAM_ACTIVE - RTMP-поток проинициализирован и соединение установлено

RTMP_CONNECTION_LOST - RTMP-соединение было потеряно

RTMP_CONNECTION_FAILED - RTMP-соединение не было установлено

caller

SIP caller - вызывающий абонент


visibleName

Отображаемое имя вызывающего абонента


mediaProvider

НЕ ИСПОЛЬЗУЕТСЯ

НЕ ИСПОЛЬЗУЕТСЯ

SDP параметры recvonly и sendrecv

...