Команда для постановки разговора на удержание.

Метод HTTP-запроса:

POST

Шаблон HTTP-запроса:

http://host:port/<DOMAIN>/service/cc/arm/call_hold

Коды ответов:

200
403 — Ошибки передаются в теле ответа

Ошибки, передаваемые в теле ответа:

  • cannot_perform_cmd

XSD-схема XML-запроса/ответа:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">

    <xs:include schemaLocation="error.xsd"/>

    <!-- responseType -->
    <xs:complexType name="CallHold">
        <!--Если не указывать Id оператора, то будет использован идентификатор оператора
            запросившего hold-->
        <xs:attribute name="operator_id" type="xs:string" use="optional"/>
        <xs:attribute name="conversation_id" type="xs:string" use="required"/>
    </xs:complexType>

    <!-- in -->
    <xs:element name="in">
        <xs:complexType>
            <xs:all>
                <xs:element name="request">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="call_hold" type="CallHold"/>
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:choice>
                <xs:element name="response">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="ok"/>
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
                <xs:element name="error" type="errorType"/>
            </xs:choice>
        </xs:complexType>
    </xs:element>
</xs:schema>
XML

Пример использует технологию websocket

Пример:
Запрос:

0100000001850018call_hold
[
  {
    "_name": "in",
    "_content": [
      {
        "_name": "request",
        "_content": [
          {
            "_name": "call_hold",
            "_attributes": {
              "conversation_id": "0647e098a4b48b05"
            }
          }
        ]
      }
    ]
  }
]
PY

Код ответа:

200

Ответ:

0100000002160018200
[
  {
    "_name": "out",
    "_attributes": {
      "xmlns:xs": "http://www.w3.org/2001/XMLSchema-instance",
      "xs:noNamespaceSchemaLocation": "call_hold.xsd"
    },
    "_content": [
      {
        "_name": "response",
        "_content": [
          {
            "_name": "ok"
          }
        ]
      }
    ]
  }
]
PY