Agent API
- Santiago Viglione (Unlicensed)
- Luna Gil (Unlicensed)
AgentLogin
POST | https://instance.ucontactcloud.com/Integra/resources/auth/AgentLogin |
|---|---|
Content-Type | application/x-www-form-urlencoded |
Parámetros | |
agent | Nombre del agente |
password | Password del agente |
Ejemplo de solicitud
curl --location --request POST 'https://instance.ucontactcloud.com/Integra/resources/auth/AgentLogin' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'agent=Jhon' \
--data-urlencode 'password=12345'Respuesta
El campo md5secret va a ser necesario enviarlo en las siguientes peticiones, ya que sirve como autenticación.
En caso de que el usuario y/o contraseña sean incorrectos la solicitud devolverá 0.
{
"id": 9997,
"name": "9999",
"host": "instance.ucontactcloud.com",
"nat": "yes",
"type": "friend",
"accountcode": "Jhon",
"callgroup": "",
"callerid": "9999",
"canreinvite": "",
"context": "entrantes",
"dtmfmode": "rfc2833",
"insecure": "",
"language": "es",
"mailbox": "",
"md5secret": "U2FudGlhZ286NWI3MWRlYmEtZTVlOC00NDBhLWExY2ItZjgxMGU0Zjg5Nzkz",
"pickupgroup": "",
"qualify": "yes",
"secret": "123456",
"disallow": "all",
"allow": "alaw;ulaw",
"port": "",
"defaultuser": "9999",
"subscribecontext": "default",
"record": "agent",
"email": "",
"phonetype": "SoftPhone",
"LogLevel": "SEVERE",
"limite": 0.0,
"transport": "wss",
"encryption": "yes",
"did": "",
"outboundproxy": "",
"fullname": "John Doe"
}AgentLogoff
POST | https://instance.ucontactcloud.com/Integra/resources/api/AgentLogoff |
|---|---|
Content-Type | application/x-www-form-urlencoded |
Parámetros | |
agent | Nombre del agente |
interface | Callerid del agente. Esto se obtiene en el AgentLogin |
message | Mensaje opcional. El mensaje quedará guardado en la tabla |
Headers | |
Authorization | Basic md5secret |
Ejemplo de solicitud
curl --location --request POST 'https://instance.ucontactcloud.com/Integra/resources/api/AgentLogoff' \
--header 'Authorization: Basic U2FudGlhZ286NTA5NTY3MzItYjU5ZC00MDhjLThmZmUtM2I1MDc3ZDg3Y2Zi' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'agent=Jhon' \
--data-urlencode 'interface=SIP/9999' \
--data-urlencode 'message=Test'HangupPhone
POST | https://instance.ucontactcloud.com/Integra/resources/Agents/HangupPhone |
|---|---|
Content-Type | application/x-www-form-urlencoded |
Parámetros | |
phone | Callerid del agente. Esto se obtiene en el AgentLogin |
Headers | |
Authorization | Basic md5secret |
Ejemplo de solicitud
Break
POST | https://instance.ucontactcloud.com/Integra/resources/api/AgentBreak |
|---|---|
Content-Type | application/x-www-form-urlencoded |
Parámetros | |
agent | Nombre del agente |
interface | Callerid del agente. Esto se obtiene en el AgentLogin |
motive | Nombre del break (tiene que ser uno que este configurado en uContact) |
message | Mensaje opcional que se guardará en la tabla |
Headers | |
Authorization | Basic md5secret |
Ejemplo de solicitud
UnBreak
POST | https://instance.ucontactcloud.com/Integra/resources/api/AgentUnBreak |
|---|---|
Content-Type | application/x-www-form-urlencoded |
Parámetros | |
agent | Nombre del agente |
interface | Callerid del agente. Esto se obtiene en el AgentLogin |
motive | Nombre del break (tiene que ser uno que este configurado en uContact) |
message | Mensaje opcional que se guardará en la tabla |
Headers | |
Authorization | Basic md5secret |
Ejemplo de solicitud
AgentCall
POST | https://instance.ucontactcloud.com/Integra/resources/Agents/AgentCall |
|---|---|
Content-Type | application/x-www-form-urlencoded |
Parámetros | |
callerid | Caller id para variable OUTDID saliente. |
agent | Nombre del agente |
phone | Callerid del agente. Esto se obtiene en el AgentLogin |
tech | Debería enviarse siempre |
context | Contexto del agente, debería ser |
outqueue | Nombre de la campaña saliente |
destination | Número de teléfono de destino |
Headers | |
Authorization | Basic md5secret |
Ejemplo de solicitud
Respuesta
Si la llamada es exitosa la respuesta será el guid único para la misma. Por ejemplo
8c78e1e1-5875-4ae7-a7ae-e3af3baeecdf
Transfer
POST | https://instance.ucontactcloud.com/Integra/resources/Agents/Transfer |
|---|---|
Content-Type | application/x-www-form-urlencoded |
Parámetros | |
channel | Canal de origen de la llamada |
context | Contexto a transferir |
exten | Extensión a transferir |
Headers | |
Authorization | Basic md5secret |
Ejemplo de solicitud
Respuesta
La respuesta será siempre 1 aunque los parámetros no sean válidos. Solo será 0 si ocurre un error interno en el servidor.
SendDTMF
La función de enviar se puede utilizar para crear comportamientos nuevos junto con los flujos o usar comportamientos previamente definidos.
DTMF | Acción |
| Parkear llamada |
POST | https://instance.ucontactcloud.com/Integra/resources/Agents/SendDTMF |
|---|---|
Content-Type | application/x-www-form-urlencoded |
Parámetros | |
channel | Canal de la llamada, al cual se quiere enviar el DTMF |
dtmf | Valor del DTMF, ejemplo: *1 |
Headers | |
Authorization | Basic md5secret |
Ejemplo de solicitud
Respuesta
La respuesta será siempre 1 aunque los parámetros no sean válidos. Solo será 0 si ocurre un error interno en el servidor.