# Finalizar Sesión

Para finalizar la sessión del agente o usuario una vez deje de utilizarse.

<p class="callout info">Usted puede verificar la [Colección de Postman](https://www.postman.com/dev-clever-ideas/ucontact/request/jll18s1/agentlogoff?tab=overview "AgentLogoff") para ver un ejemplo y probar con su instancia.</p>

<p class="callout info">Todos los datos que esten encerrados por "{{ }}" son valores que serán reemplazado con los datos del propio cliente y/o la instancia correspondiente.</p>

---

### HTTP Request

<table border="1" id="bkmrk-opcion-http-valor-re" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="height: 29.7969px;"><td class="align-center" style="width: 21.5016%; height: 29.7969px;">**Metodo**</td><td class="align-center" style="width: 78.4737%; height: 29.7969px;">**Recurso**</td></tr><tr style="height: 29.7969px;"><td style="width: 21.5016%; height: 29.7969px;">POST</td><td style="width: 78.4737%; height: 29.7969px;">/Integra/resources/api/AgentLogoff</td></tr></tbody></table>

#### Request Headers

<table border="1" class="align-center" id="bkmrk-parametro-tipo-descr" style="border-collapse: collapse; width: 100%; height: 89.9875px;"><tbody><tr style="height: 29.7875px;"><td style="width: 21.6483%; height: 29.7875px;">**Clave**</td><td style="width: 78.4506%; height: 29.7875px;">**Valor**</td></tr><tr style="height: 30.6px;"><td class="align-left" style="width: 21.6483%; height: 30.6px;">Content-Type</td><td class="align-left" style="width: 78.4506%; height: 30.6px;">application/x-www-form-urlencoded</td></tr><tr style="height: 29.6px;"><td class="align-left" style="width: 21.6483%; height: 29.6px;">Authorization</td><td class="align-left" style="width: 78.4506%; height: 29.6px;">Basic Token</td></tr></tbody></table>

#### Request Body

<table border="1" class="align-center" id="bkmrk-parametro-tipo-reque" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><tbody><tr style="height: 29.7969px;"><td style="width: 21.0136%; height: 29.7969px;">**Parametro**</td><td style="width: 20.5192%; height: 29.7969px;">**Tipo**</td><td style="width: 13.8485%;">**Requerido**</td><td style="width: 44.6187%; height: 29.7969px;">**Descripción**</td></tr><tr style="height: 29.7969px;"><td class="align-left" style="width: 21.0136%; height: 29.7969px;">agent</td><td class="align-left" style="width: 20.5192%; height: 29.7969px;">Texto (String)</td><td style="width: 13.8485%;">Si</td><td class="align-left" style="width: 44.6187%; height: 29.7969px;">Nombre de usuario que se va a desloguar</td></tr><tr><td class="align-left" style="width: 21.0136%;">interface</td><td class="align-left" style="width: 20.5192%;">Texto (String)</td><td style="width: 13.8485%;">No</td><td class="align-left" style="width: 44.6187%;">Numero de telefono/extensión del sip para el agente</td></tr><tr style="height: 29.7969px;"><td class="align-left" style="width: 21.0136%; height: 29.7969px;">message</td><td class="align-left" style="width: 20.5192%; height: 29.7969px;">Texto (String)</td><td style="width: 13.8485%;">No</td><td class="align-left" style="width: 44.6187%; height: 29.7969px;">Mensaje a guardar</td></tr></tbody></table>


---

### Ejemplos de codigo

<p class="callout info">Puede copiar los siguientes ejemplos de codigo y reemplazar las variables "{{variable}}" con los datos correctos.</p>

#### HTTP

```HTTP
POST /Integra/resources/api/AgentLogoff HTTP/1.1
Host: {{domain}}.ucontactcloud.com
Authorization: Basic {{Token}}
Content-Type: application/x-www-form-urlencoded
Content-Length: 55

agent={{user}}&interface=SIP/{{extension}}&message=Desloguear
```

##### cURL

```
curl --location --request POST 'https://{{domain}}.ucontactcloud.com/Integra/resources/api/AgentLogoff' \
--header 'Authorization: Basic {{Token}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'agent={{User}}' \
--data-urlencode 'interface=SIP/{{Extension}}' \
--data-urlencode 'message={{Mensaje}}'
```

##### JavaScript

```JavaScript
var myHeaders = new Headers();
myHeaders.append("Authorization", "Basic {{Token}}");
myHeaders.append("Content-Type", "application/x-www-form-urlencoded");

var urlencoded = new URLSearchParams();
urlencoded.append("agent", "{{User}}");
urlencoded.append("interface", "SIP/{{Extension}}");
urlencoded.append("message", "{{Mensaje}}");

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: urlencoded,
  redirect: 'follow'
};

fetch("https://{{domain}}.ucontactcloud.com/Integra/resources/api/AgentLogoff", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

##### JQuery

```JavaScript
var settings = {
  "url": "https://{{domain}}.ucontactcloud.com/Integra/resources/api/AgentLogoff",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Authorization": "Basic {{Token}}",
    "Content-Type": "application/x-www-form-urlencoded"
  },
  "data": {
    "agent": "{{User}}",
    "interface": "SIP/{{Extension}}",
    "message": "{{Mensaje}}"
  }
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
```

##### C#

```C#
var client = new RestClient("https://{{domain}}.ucontactcloud.com/Integra/resources/api/AgentLogoff");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Basic {{Token}}");
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("agent", "{{User}}");
request.AddParameter("interface", "SIP/{{Extension}}");
request.AddParameter("message", "{{Mensaje}}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
```

##### Java

```Java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "agent={{User}}&interface=SIP/{{Extension}}&message={{Mensaje}}");
Request request = new Request.Builder()
  .url("https://{{domain}}.ucontactcloud.com/Integra/resources/api/AgentLogoff")
  .method("POST", body)
  .addHeader("Authorization", "Basic {{Token}}")
  .addHeader("Content-Type", "application/x-www-form-urlencoded")
  .build();
Response response = client.newCall(request).execute();
```

##### Python

```Python
import http.client

conn = http.client.HTTPSConnection("{{domain}}.ucontactcloud.com")
payload = 'agent={{User}}&interface=SIP/{{Extension}}&message={{Mensaje}}'
headers = {
  'Authorization': 'Basic {{Token}}',
  'Content-Type': 'application/x-www-form-urlencoded'
}
conn.request("POST", "/Integra/resources/api/AgentLogoff", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
```

---

### HTTP Response

#### Respuesta Exitosa

```Text
Success
```

#### Respuesta de error

```JSON
0
```