Hacer Llamada

En algunas ocasiones, es necesario que un agente genere una llamada a un número de teléfono desde otra aplicación, como podría ser un CRM. Se puede utilizar esta API, y la llamada será enviada al agente. 

 Usted puede verificar la Colección de Postman para ver un ejemplo y probar con su instancia. 

 Todos los datos que esten encerrados por "{{ }}" son valores que serán reemplazado con los datos del propio cliente y/o la instancia correspondiente. 

 HTTP Request 

 Metodo 

 Recurso 

 POST 

 /Integra/resources/Agents/AgentCall 

 Request Header 

 

 Clave 

 Valor 

 Content-Type 

 application/x-www-form-urlencoded 

 Authorization 

 Basic {{Token}} 

 Request Body 

 Parametro 

 Tipo 

 Requerido 

 Descripción 

 callerid 

 Número 

 Si 

 DID asignado a la campaña por la cual se realizará la llamada. 

 agent 

 Texto 

 Si 

 Agente que tomará la llamada. 

 

 phone 

 

 Número 

 Si 

 Número de teléfono del agente. 

 tech 

 Texto 

 Si 

 Protocolo de comunicación, agregar SIP. 

 context 

 Texto 

 Si 

 Nombre del contexto para flujos por el cual saldrá la llamada. Puede ser "agentes" o "agents" 

 outqueue 

 Texto 

 Si 

 Nombre de la campaña manual. 

 destination 

 Número 

 Si 

 Nombre de la campaña por la cual se generará la llamada. 

 

 Ejemplos de Código 

 Puede copiar los siguientes ejemplos de codigo y reemplazar las variables "{{variable}}" con los datos correctos. 

 HTTP 

 POST /Integra/resources/Agents/AgentCall HTTP/1.1

Host: {{instance}}.ucontactcloud.com

Authorization: Basic {{Token}}

Content-Type: application/x-www-form-urlencoded

Content-Length: 116

callerid={{callerid}}agent={{agent}}&phone={{phone}}&tech=SIP&context={{context}}&outqueue={{outqueue}}&destination={{destination}} 

 cURL 

 curl --location 'https://{{instance}}.ucontactcloud.com/Integra/resources/Agents/AgentCall' \

--header 'Authorization: Basic {{Token}}' \

--header 'Content-Type: application/x-www-form-urlencoded' \

--data-urlencode 'callerid={{callerid}}' \

--data-urlencode 'agent={{agent}}' \

--data-urlencode 'phone={{phone}}' \

--data-urlencode 'tech=SIP' \

--data-urlencode 'context={{context}}' \

--data-urlencode 'outqueue={{outqueue}}' \

--data-urlencode 'destination={{destination}}' 

 JavaScript 

 const myHeaders = new Headers();

myHeaders.append("Authorization", "Basic {{Token}}");

myHeaders.append("Content-Type", "application/x-www-form-urlencoded");

const urlencoded = new URLSearchParams();

urlencoded.append("callerid", "{{callerid}}");

urlencoded.append("agent", "{{agent}}");

urlencoded.append("phone", "{{phone}}");

urlencoded.append("tech", "SIP");

urlencoded.append("context", "{{context}}");

urlencoded.append("outqueue", "{{outqueue}}");

urlencoded.append("destination", "{{destination}}");

const requestOptions = {

 method: "POST",

 headers: myHeaders,

 body: urlencoded,

 redirect: "follow"

};

fetch("https://{{instance}}.ucontactcloud.com/Integra/resources/Agents/AgentCall", requestOptions)

 .then((response) => response.text())

 .then((result) => console.log(result))

 .catch((error) => console.error(error)); 

 JQuery 

 var settings = {

 "url": "https://{{instance}}.ucontactcloud.com/Integra/resources/Agents/AgentCall",

 "method": "POST",

 "timeout": 0,

 "headers": {

 "Authorization": "Basic {{Token}}",

 "Content-Type": "application/x-www-form-urlencoded"

 },

 "data": {

 "callerid": "{{callerid}}",

 "agent": "{{agent}}",

 "phone": "{{phone}}",

 "tech": "SIP",

 "context": "{{context}}",

 "outqueue": "{{outqueue}}",

 "destination": "{{destination}}"

 }

};

$.ajax(settings).done(function (response) {

 console.log(response);

}); 

 C# 

 var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://{{instance}}.ucontactcloud.com/Integra/resources/Agents/AgentCall");

request.Headers.Add("Authorization", "Basic {{Token}}");

var collection = new List<KeyValuePair<string, string>>();

collection.Add(new("callerid", "{{callerid}}"));

collection.Add(new("agent", "{{agent}}"));

collection.Add(new("phone", "{{phone}}"));

collection.Add(new("tech", "SIP"));

collection.Add(new("context", "{{context}}"));

collection.Add(new("outqueue", "{{outqueue}}"));

collection.Add(new("destination", "{{destination}}"));

var content = new FormUrlEncodedContent(collection);

request.Content = content;

var response = await client.SendAsync(request);

response.EnsureSuccessStatusCode();

Console.WriteLine(await response.Content.ReadAsStringAsync());

 

 Java 

 OkHttpClient client = new OkHttpClient().newBuilder()

 .build();

MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");

RequestBody body = RequestBody.create(mediaType, "callerid={{callerid}}&agent={{agent}}&phone={{phone}}&tech=SIP&context={{context}}&outqueue={{outqueue}}&destination={{destination}}");

Request request = new Request.Builder()

 .url("https://{{instance}}.ucontactcloud.com/Integra/resources/Agents/AgentCall")

 .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("{{instance}}.ucontactcloud.com")

payload = 'callerid={{callerid}}&agent={{agent}}&phone={{phone}}&tech=SIP&context={{context}}&outqueue={{outqueue}}&destination={{destination}}'

headers = {

 'Authorization': 'Basic {{Token}}',

 'Content-Type': 'application/x-www-form-urlencoded'

}

conn.request("POST", "/Integra/resources/Agents/AgentCall", payload, headers)

res = conn.getresponse()

data = res.read()

print(data.decode("utf-8")) 

 

 

 HTTP Response 

 Las respuestas en las que se obtubo error por parte de los datos enviados por lo general serán entregados con codigo HTTP 200 con un "0" en el body de la respuesta, por lo tanto hay que tener cuidado al validar por el HTTP Code Response. 

 La respuesta exitosa será un GUID como identificador de la llamada; con este dato se podrán realizar futuras acciones mediante APIs. 

 Respuesta exitosa 

 8cf8570e-60e7-44ed-b799-3baab211b04d 

 Respuesta de error 

 0