====== MIKO Proxy Server ======

<note warning>Документ в разработке</note>

Обмен сообщениями с клиентам осуществляется по протоколу [[https://ru.wikipedia.org/wiki/WebSocket|WebSocket]].

Сообщения формируются в формате [[https://ru.wikipedia.org/wiki/JSON|JSON]].

Выделяются три категории сообщений:
  * действие (action);
  * ответ (respons);
  * событие (event).

===== Действия =====

=== Авторизация ===
<code>{
  "action":"auth",
  "id":"0001",
  "data":{
    "extension":"140",
    "name":"Maxim Tsvetkov"
  }
}</code>

=== Звонок ===
<code>{
  "action":"call",
  "id":"0001",
  "data":{
    "from":{
      "extension":"140"
    },
  "to_number":"112"
  }
}</code>

=== Завершение звонка ===
<code>{
  "action":"hangup",
  "id":"0001",
  "data":{
    "call_id":"askozia-1445526019"
  }
}</code>

=== Переадресация звонка ===
<code>{
  "action":"redirect",
  "id":"0001",
  "data":{
    "call_id":"askozia-1445526019",
    "extension":"SIP/140",
    "to_number":"112"
  }
}</code>

=== Перевод звонка с консультацией ===
<code>{
  "action":"atxfer",
  "id":"0001",
  "data":{
    "call_id":"askozia-1445526019",
    "extension":"SIP/140",
    "to_number":"112"
  }
}</code>

===== Ответы =====

Пример ответа на успешно выполненное действие:
<code>{
  "response":"auth",
  "id":"0001",
  "status":"ok",
  "cause":""
  }
}</code>

Пример ответа на действие завершившиеся ошибкой:
<code>{
  "response":"call",
  "id":"0001",
  "status":"fault",
  "cause":""
  }
}</code>

===== События =====

=== Изменение статуса звонка ===

<code>{
  "event":"call",
  "data":{
    "call_id":"askozia-1445526019",
    "state":"Calling",
    "from":{
      "extension":"SIP\140",
      "number":"140"
    },
    "to":{
      "extension":"SIP\112",
      "number":"112"
    }
  }
}</code>

Виды статусов звонка:
  * Calling - инициация звонка;
  * Connected - соединение абонентов;
  * Hangup - завершение звонка.