Cronologia pagina

Versioni confrontate

Chiave

  • Questa linea è stata aggiunta.
  • Questa linea è stata rimossa.
  • La formattazione è stata modificata.

...

HTML
            <div class="content">
                <section id="panoramica" class="resource-group">
                    <h2 class="group-heading">Panoramica <a href="#panoramica" class="permalink">&para;</a></h2>
                    <h2 id="header-introduzione">Introduzione <a class="permalink" href="#header-introduzione" aria-hidden="true">¶</a></h2>
                    <p>Con l’API Call2Action si possono effettuare chiamate telefoniche da un Numero Verde TIM verso numerazioni fisse/mobili nazionali, specificando in modo dinamico ed immediato il servizio che verra’ erogato nel corso delle chiamate. Sara’ possibile quindi verificarne l’esito ed i dati collezionati nel corso delle chiamate.</p>
                </section>
                <section id="sicurezza" class="resource-group">
                    <h2 class="group-heading">Sicurezza <a href="#sicurezza" class="permalink">&para;</a></h2>
                    <h2 id="header-autenticazione">Autenticazione <a class="permalink" href="#header-autenticazione" aria-hidden="true">¶</a></h2>
                    <p>L’API Call2Action descritta in questo documento adotterà il meccanismo di autenticazione che si basa su un API-Key. L’API-Key sarà fornita nel parametro <code>KeyId</code> dell’header http della richiesta.</p>
                </section>
                <section id="developers" class="resource-group">
                    <h2 class="group-heading">Developers <a href="#developers" class="permalink">&para;</a></h2>
                    <div id="developers-callexecute" class="resource">
                        <h3 class="resource-heading">CallExecute <a href="#developers-callexecute" class="permalink">&nbsp;&para;</a></h3>
                        <div id="developers-callexecute-post" class="action post">
                            <h4 class="action-heading"><div class="name">CallExecute</div><a href="#developers-callexecute-post" class="method post">POST</a><code class="uri">/call2action/call</code></h4>
                            <p>Da usere per richiedere l’esecuzione una chiamata telefonica da un Numero Verde TIM verso una numerazione fissa o mobile nazionale impostando contestualmente la struttura e i contenuti del servizio vocale che verra’ eroagato nel corso della chiamata stessa. Nel caso di mancata risposta da parte dell’utente finale il servizio provera’ ad effettuare fino a 3 tentativi distanziati temporalmente di circa 5 minuti.</p>
                            <p>I caratteri gestiti dall’api sono: tutte le lettere (non accentate) maiuscole e minuscole, tutti i caratteri numerici, l’apostrofo e la punteggiatura (, ; . ! ?). Per gestire le lettere accentate occorre postporre l’apostrofo alla vocale da accentare.</p>
                            <h4>Example URI</h4>
                            <div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname"></span>/call2action/call</span>
                            </div>
                            <div class="title"><strong>Request</strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre>
                                    <div style="height: 1px;"></div>
                                    <h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">Call</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">CalledNumber</span>": <span class="hljs-value"><span class="hljs-string">"0611111111"</span></span>,
    "<span class="hljs-attribute">PresentationNumber</span>": <span class="hljs-value"><span class="hljs-string">"8001111111"</span></span>,
    "<span class="hljs-attribute">Service</span>": <span class="hljs-value"><span class="hljs-string">"Servizio comunicazione fine pratica"</span></span>,
    "<span class="hljs-attribute">Messages</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">WelcomeMessage</span>": <span class="hljs-value"><span class="hljs-string">"Buongiorno, la nostra azienda e' lieta di comunicarle che la sua pratica e' stata lavorata e i nostri uffici saranno a sua disposizione per rilasciarle i documenti previsti. Puo' premere 1 se pensa di potere passare per il ritiro entro la settimana corrente, 2 se vuole parlare con un nostro operatore. Grazie"</span></span>,
      "<span class="hljs-attribute">ByeMessage</span>": <span class="hljs-value"><span class="hljs-string">"Grazie per la sua gentile collaborazione. Il nostro obbiettivo e' quello di essere sempre piu' tempestivi nella comunicazione verso i nostri clienti. A risentirci."</span>
    </span>}</span>,
    "<span class="hljs-attribute">ListOfValidDigits</span>": <span class="hljs-value">[
      {
        "<span class="hljs-attribute">Digit</span>": <span class="hljs-value"><span class="hljs-string">"1"</span></span>,
        "<span class="hljs-attribute">ResponseMessage</span>": <span class="hljs-value"><span class="hljs-string">"Grazie, ci vedremo a breve nei nostri uffici"</span></span>,
        "<span class="hljs-attribute">CallTransferNumber</span>": <span class="hljs-value"><span class="hljs-string">""</span>
      </span>},
      {
        "<span class="hljs-attribute">Digit</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
        "<span class="hljs-attribute">ResponseMessage</span>": <span class="hljs-value"><span class="hljs-string">"Attendenda in linea"</span></span>,
        "<span class="hljs-attribute">CallTransferNumber</span>": <span class="hljs-value"><span class="hljs-string">"0805555555"</span>
      </span>}
    ]
  </span>}
</span>}</code></pre>
                                    <div style="height: 1px;"></div>
                                    <h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"Call"</span>
  ]</span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">Call</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
      "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
        <span class="hljs-string">"CalledNumber"</span>,
        <span class="hljs-string">"PresentationNumber"</span>,
        <span class="hljs-string">"Service"</span>,
        <span class="hljs-string">"Description"</span>,
        <span class="hljs-string">"Messages"</span>
      ]</span>,
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">CalledNumber</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
          "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica la numerazione fissa o mobile nazionale dell’utente finale verso la quale sara’ effettuata la chiamata. Nel caso di mancata risposta da parte dell'utente finale il servizio provera' ad effettuare fino a 3 tentativi distanziati temporalmente di circa 5 minuti"</span>
        </span>}</span>,
        "<span class="hljs-attribute">PresentationNumber</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
          "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica il Numero Verde TIM con cui la chiamata si presentera’ all’utente finale."</span>
        </span>}</span>,
        "<span class="hljs-attribute">Service</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
          "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica il servizio vocale che verra’ erogato nel corso della chiamata richiesta e che verra’ configurato contestualmente "</span>
        </span>}</span>,
        "<span class="hljs-attribute">Messages</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
          "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Messaggi in formato testuale che verranno recitati all’utente finale chiamato"</span></span>,
          "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">WelcomeMessage</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">maxLength</span>": <span class="hljs-value"><span class="hljs-number">500</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica il testo (fino a 500 caratteri) che verra’ recitato dal servizio vocale all’utente finale chiamato all’inizio della chiamata"</span>
            </span>}</span>,
            "<span class="hljs-attribute">ByeMessage</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">maxLength</span>": <span class="hljs-value"><span class="hljs-number">250</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica il testo (fino a 250 caratteri) che verra’ recitato dal servizio vocale all’utente finale chiamato alla fine della chiamata"</span>
            </span>}
          </span>}
        </span>}</span>,
        "<span class="hljs-attribute">ListOfValidDigits</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
          "<span class="hljs-attribute">items</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
            "<span class="hljs-attribute">minItems</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>,
            "<span class="hljs-attribute">maxItems</span>": <span class="hljs-value"><span class="hljs-number">11</span></span>,
            "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
              <span class="hljs-string">"Digits"</span>,
              <span class="hljs-string">"ResponseMessage"</span>
            ]</span>,
            "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">Digit</span>": <span class="hljs-value">{
                "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
                "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica un codice numerico specifico (fino a 10 cifre) che potra’ essere inserito dall’utente finale nel corso della chiamata e sara’ riconosciuto come valido dal servizio vocale. Laddove si indichi * si intendera' valido un qualsiasi codice numerico di lunghezza da 0 a 10 cifre"</span>
              </span>}</span>,
              "<span class="hljs-attribute">ResponseMessage</span>": <span class="hljs-value">{
                "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
                "<span class="hljs-attribute">maxLength</span>": <span class="hljs-value"><span class="hljs-number">250</span></span>,
                "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica il testo (fino a 250 caratteri) che verra’ recitato dal servizio vocale all’utente finale nel caso abbia inserito il codice numerico valido. In caso contrario verra' recitato un messaggio di cortesia predefinito"</span>
              </span>}</span>,
              "<span class="hljs-attribute">CallTransferNumber</span>": <span class="hljs-value">{
                "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
                "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica la numerazione fissa o mobile nazionale con cui verra’ messa a passaggio dal servizio la chiamata in corso con l’utente finale in seguito l’inserimento del codice numerico specifico. Il limite di tempo per il trasferimento di chiamata è di 180 secondi"</span>
              </span>}
            </span>}
          </span>}
        </span>}
      </span>}
    </span>}
  </span>}
</span>}</code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                            <div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <div class="description">
                                        <p>successful operation</p>
                                    </div>
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre>
                                    <div style="height: 1px;"></div>
                                    <h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">CallResponse</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">CallID</span>": <span class="hljs-value"><span class="hljs-string">"7fd5a342-1c4f-4e1b-86f1-426b351eacd9"</span>
  </span>}</span>,
  "<span class="hljs-attribute">OperationResponse</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">ErrorDescription</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>,
    "<span class="hljs-attribute">Message</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>,
    "<span class="hljs-attribute">Outcome</span>": <span class="hljs-value"><span class="hljs-number">0</span>
  </span>}
</span>}</code></pre>
                                    <div style="height: 1px;"></div>
                                    <h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"CallResponse"</span>,
    <span class="hljs-string">"OperationResponse"</span>
  ]</span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">CallResponse</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
      "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
        <span class="hljs-string">"CallID"</span>
      ]</span>,
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">CallID</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
          "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Identifica in maniera univoca la richiesta di chiamata acquisita correttamente da parte Call2Action nel corso di una operazione di CallExecute"</span>
        </span>}
      </span>}
    </span>}</span>,
    "<span class="hljs-attribute">OperationResponse</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
      "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
        <span class="hljs-string">"Outcome"</span>,
        <span class="hljs-string">"ErrorDescription"</span>,
        <span class="hljs-string">"Message"</span>
      ]</span>,
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">ErrorDescription</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
          "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica una descrizione dell’eventuale errore occorso nel caso in cui Outcome sia diverso da “0” (esito ultima operazione negativo)"</span>
        </span>}</span>,
        "<span class="hljs-attribute">Message</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
          "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica un messaggio che puo’ eventualmente essere specificato ad integrazione di quanto indicato in ErrorDescription."</span>
        </span>}</span>,
        "<span class="hljs-attribute">Outcome</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
          "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica l’esito dell’ultima operazione eseguita. Un valore pari a “0” indica un esito positivo, ovvero, la corretta acquisizione da parte Call2Action della richiesta di chiamata fatta."</span>
        </span>}
      </span>}
    </span>}
  </span>}
</span>}</code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                            <div class="title"><strong>Response&nbsp;&nbsp;<code>400</code></strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <div class="description">
                                        <p>La richiesta non è stata formulata in maniera corretta.</p>
                                    </div>
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                            <div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <div class="description">
                                        <p>Risorsa non trovata</p>
                                    </div>
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                            <div class="title"><strong>Response&nbsp;&nbsp;<code>403</code></strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <div class="description">
                                        <p>Errore di autenticazione</p>
                                    </div>
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                            <div class="title"><strong>Response&nbsp;&nbsp;<code>412</code></strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <div class="description">
                                        <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p>
                                    </div>
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                            <div class="title"><strong>Response&nbsp;&nbsp;<code>415</code></strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <div class="description">
                                        <p>Media Type non supportato</p>
                                    </div>
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                            <div class="title"><strong>Response&nbsp;&nbsp;<code>500</code></strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <div class="description">
                                        <p>Errore generico del server</p>
                                    </div>
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                        </div>
                    </div>
                    <div id="developers-callstatus" class="resource">
                        <h3 class="resource-heading">CallStatus <a href="#developers-callstatus" class="permalink">&nbsp;&para;</a></h3>
                        <div id="developers-callstatus-get" class="action get">
                            <h4 class="action-heading"><div class="name">CallStatus</div><a href="#developers-callstatus-get" class="method get">GET</a><code class="uri">/call2action/call/{CallID}</code></h4>
                            <p>Da usere per verificare lo stato dell’esecuzione della chiamata telefonica richiesta tramite una operazione di CallExecute ed acquisire i dati eventualmente collezionati dall’interazione con l’utente finale nel corso della chiamata telefonica stessa</p>
                            <h4>Example URI</h4>
                            <div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname"></span>/call2action/call/<span class="hljs-attribute" title="CallID">CallID</span></span>
                            </div>
                            <div class="title"><strong>URI Parameters</strong>
                                <div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <dl class="inner"><dt>CallID</dt>
                                    <dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;
                                        <p>Identifica in maniera univoca la richiesta di chiamata acquisita correttamente da parte Call2Action nel corso di una operazione di CallExecute</p>
                                    </dd>
                                </dl>
                            </div>
                            <div class="title"><strong>Request</strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                            <div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <div class="description">
                                        <p>successful operation</p>
                                    </div>
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre>
                                    <div style="height: 1px;"></div>
                                    <h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">CallResponse</span>": <span class="hljs-value">[
    {
      "<span class="hljs-attribute">Progress</span>": <span class="hljs-value"><span class="hljs-string">"FINAL"</span></span>,
      "<span class="hljs-attribute">Result</span>": <span class="hljs-value"><span class="hljs-string">"OK"</span></span>,
      "<span class="hljs-attribute">CollectedDigits</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
      "<span class="hljs-attribute">CallTransferNumber</span>": <span class="hljs-value"><span class="hljs-string">"0123456789"</span></span>,
      "<span class="hljs-attribute">CallTransferResult</span>": <span class="hljs-value"><span class="hljs-string">"OK"</span>
    </span>}
  ]</span>,
  "<span class="hljs-attribute">OperationResponse</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">ErrorDescription</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>,
    "<span class="hljs-attribute">Message</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>,
    "<span class="hljs-attribute">Outcome</span>": <span class="hljs-value"><span class="hljs-number">0</span>
  </span>}
</span>}</code></pre>
                                    <div style="height: 1px;"></div>
                                    <h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"OperationResponse"</span>,
    <span class="hljs-string">"CallResponse"</span>
  ]</span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">CallResponse</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
      "<span class="hljs-attribute">items</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
        "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
          <span class="hljs-string">"Progress"</span>,
          <span class="hljs-string">"Result"</span>
        ]</span>,
        "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">Progress</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
            "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica se la richiesta di chiamata effettuata dalla Terza Parte Cliente identificata univocamente dal CallID sia stata completata ('Final' indichera' che si tratta di uno stato definitivo) oppure se sia ancora in corso ('Partial' indichera' che sono in corso ancora delle attivita' relative alla richiesta effettuata) "</span>
          </span>}</span>,
          "<span class="hljs-attribute">Result</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
            "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica se l’utente finale verso il quale e’ stata effetuata la chiamata da Call2Action abbia risposto ('Eseguita con successo') o meno"</span>
          </span>}</span>,
          "<span class="hljs-attribute">CollectedDigits</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
            "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica quale codice abbia eventualmente selezionato l’utente finale nel corso della chiamata tra quelli validi in caso di risposta alla chiamata"</span>
          </span>}</span>,
          "<span class="hljs-attribute">CallTransferNumber</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
            "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica la numerazione con cui la chiamata con l'utente finale e' stata messa a passaggio dal servizio vocale"</span>
          </span>}</span>,
          "<span class="hljs-attribute">CallTransferResult</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
            "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica se la messa a passaggio dell'utente finale sia andata a buon fine ('Eseguita con successo') o meno"</span>
          </span>}
        </span>}
      </span>}
    </span>}</span>,
    "<span class="hljs-attribute">OperationResponse</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
      "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
        <span class="hljs-string">"Outcome"</span>,
        <span class="hljs-string">"ErrorDescription"</span>,
        <span class="hljs-string">"Message"</span>
      ]</span>,
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">ErrorDescription</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
          "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica una descrizione dell’eventuale errore occorso nel caso in cui Outcome sia diverso da “0” (esito ultima operazione negativo)"</span>
        </span>}</span>,
        "<span class="hljs-attribute">Message</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
          "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica un messaggio che puo’ eventualmente essere specificato ad integrazione di quanto indicato in ErrorDescription. Ad esempio, possibili suggerimenti per la Terza Parte Cliente in relazione al superamento di problematiche di utilizzo dell’operazione CallStatus"</span>
        </span>}</span>,
        "<span class="hljs-attribute">Outcome</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
          "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Indica l’esito dell’ultima operazione eseguita. Un valore pari a “0” indica un esito positivo, ovvero, la corretta acquisizione da parte Call2Action della richiesta di chiamata fatta dalla Terza Parte Cliente"</span>
        </span>}
      </span>}
    </span>}
  </span>}
</span>}</code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                            <div class="title"><strong>Response&nbsp;&nbsp;<code>400</code></strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <div class="description">
                                        <p>La richiesta non è stata formulata in maniera corretta.</p>
                                    </div>
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                            <div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <div class="description">
                                        <p>Risorsa non trovata</p>
                                    </div>
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                            <div class="title"><strong>Response&nbsp;&nbsp;<code>403</code></strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <div class="description">
                                        <p>Errore di autenticazione</p>
                                    </div>
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                            <div class="title"><strong>Response&nbsp;&nbsp;<code>412</code></strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <div class="description">
                                        <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p>
                                    </div>
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                            <div class="title"><strong>Response&nbsp;&nbsp;<code>415</code></strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <div class="description">
                                        <p>Media Type non supportato</p>
                                    </div>
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                            <div class="title"><strong>Response&nbsp;&nbsp;<code>500</code></strong>
                                <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div>
                            </div>
                            <div class="collapse-content">
                                <div class="inner">
                                    <div class="description">
                                        <p>Errore generico del server</p>
                                    </div>
                                    <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre>
                                    <div style="height: 1px;"></div>
                                </div>
                            </div>
                        </div>
                    </div>
                </section>
            </div>







Copyright © 2016 Telecom Italia S.p.A. - P.IVA 00488410010