Log Out

This API is used to log out the agent or user once they are no longer in use.

You can check the Postman Collection to test in your instance.

All data enclosed in "{{ }}" are values that will be replaced with the client's own data and/or the corresponding instance.

HTTP Request Information

HTTP OptionMethod	ValueResource
ResourcePOST	/Integra/resources/api/AgentLogoff

Request Header

Key	Value
Content-Type	application/x-www-form-urlencoded
Authorization	Basic Token

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=Vcisneros&interface=SIP%2F1997&message=Desloguear

---

HTTP Request

Request ParametersBody

Parameter	Type	Required	Description
agent	Text (String)	Yes	Username to log out
interface	Text (String)	No	Phone number/extension of the SIP for the agent
message	Text (String)	No	Message to save

---

Code Examples

You can copy the following code examples and replace the "{{variable}}" with the correct data.

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=Vcisneros&interface=SIP%2F1997&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

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

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#

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

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

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

Successful Response

Success

Error Response

0