...
POST | https://instance.ucontactcloud.com/Integra/resources/api/AgentLogoff | ||
---|---|---|---|
Content-Type | application/x-www-form-urlencoded | ||
ParámetrosParameters | |||
agentNombre | del agenteAgent’s name | ||
interface | Agent’s Callerid del agente. Esto se obtiene en el AgentLogin | message | Mensaje opcional. El mensaje quedará guardado en la tabla . This is obtained in the AgentLogin. |
message | Optional message to be saved in the | ||
Headers | |||
Authorization | Basic md5secret |
...
Request example
Code Block | ||
---|---|---|
| ||
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' |
...
POST | https://instance.ucontactcloud.com/Integra/resources/Agents/HangupPhone |
---|---|
Content-Type | application/x-www-form-urlencoded |
ParámetrosParameters | |
phone | Agent’s Callerid del agente. Esto se obtiene en el AgentLogin. This is obtained in the AgentLogin. |
Headers | |
Authorization | Basic md5secret |
...
Request example
Code Block | ||
---|---|---|
| ||
curl --location --request POST 'https://instance.ucontactcloud.com/Integra/resources/Agents/HangupPhone' \ --header 'Authorization: Basic U2FudGlhZ286NTA5NTY3MzItYjU5ZC00MDhjLThmZmUtM2I1MDc3ZDg3Y2Zi' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'phone=1234' |
...
POST | https://instance.ucontactcloud.com/Integra/resources/api/AgentUnBreak |
---|---|
Content-Type | application/x-www-form-urlencoded |
Parameters | |
agent | Agent’s name. |
interface | Agent’s Callerid. This is obtained in the AgentLogin. |
motive | Name of the break (It has to be one set up in uContact) |
message | Optional message to be saved in the |
Headers | |
Authorization | Basic md5secret |
Request example
Code Block | ||
---|---|---|
| ||
curl --location --request POST 'https://instance.ucontactcloud.com/Integra/resources/api/AgentBreak' \ --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' \ --data-urlencode 'motive=Lunch' |
...
POST | https://instance.ucontactcloud.com/Integra/resources/Agents/AgentCall | ||
---|---|---|---|
Content-Type | application/x-www-form-urlencoded | ||
ParámetrosParameters | |||
callerid | Caller id para variable OUTDID salienteID for outbound OUTDID variable. | ||
agentNombre | del agenteAgent’s name | ||
phone | Agent’s Callerid del agente. Esto se obtiene en el AgentLogin | tech | Debería enviarse siempre . This is obtained in the AgentLogin. |
tech | Must always be sent like | ||
context | Contexto del agente, debería ser Agent context, it must be | ||
outqueueNombre de la campaña saliente | Outbound campaign name | ||
destinationNúmero de teléfono de destino | Destination phone number | ||
Headers | |||
Authorization | Basic md5secret |
...
Request example:
Code Block | ||
---|---|---|
| ||
curl --location --request POST 'https://instance.ucontactcloud.com/Integra/resources/Agents/AgentCall' \ --header 'Authorization: Basic U2FudGlhZ286NTA5NTY3MzItYjU5ZC00MDhjLThmZmUtM2I1MDc3ZDg3Y2Zi' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'callerid=1234' \ --data-urlencode 'agent=Jhon' \ --data-urlencode 'phone=9999' \ --data-urlencode 'tech=SIP' \ --data-urlencode 'context=agentes' \ --data-urlencode 'outqueue=saliente' \ --data-urlencode 'destination=97897667' |
Respuesta
...
Answer
If the call is successful, the answer will be the unique guide for it. For instance:
8c78e1e1-5875-4ae7-a7ae-e3af3baeecdf
...
POST | https://instance.ucontactcloud.com/Integra/resources/Agents/Transfer |
---|---|
Content-Type | application/x-www-form-urlencoded |
ParámetrosParameters | |
channelCanal de origen de la llamada | Call source channel |
contextContexto a transferir | Context to transfer |
extenExtensión a transferir | Extension to transfer |
Headers | |
Authorization | Basic md5secret |
...
Request example:
Code Block | ||
---|---|---|
| ||
curl --location --request POST 'https://instance.ucontactcloud.com/Integra/resources/Agents/Transfer' \ --header 'Authorization: Basic U2FudGlhZ286NTA5NTY3MzItYjU5ZC00MDhjLThmZmUtM2I1MDc3ZDg3Y2Zi' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'channel=1234' \ --data-urlencode 'context=Agentes' \ --data-urlencode 'exten=9999' |
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
...
#3
...
Answer
The answer will always be 1 even if the parameters are not valid. It will only be 0 if an internal error occurs on the server.
SendDTMF
The submit function can be used to create new behaviors along with flows, or use previously defined behaviors.
DTMF | Action |
| Park call |
POST | https://instance.ucontactcloud.com/Integra/resources/Agents/SendDTMF |
---|---|
Content-Type | application/x-www-form-urlencoded |
ParámetrosParameters | |
channelCanal | de la llamada, al cual se quiere enviar el Call channel, to which you want to send the DTMF |
dtmf | Valor del DTMF value, ejemploexample: *1 |
Headers | |
Authorization | Basic md5secret |
...
Request example
Code Block | ||
---|---|---|
| ||
curl --location --request POST 'https://instance.ucontactcloud.com/Integra/resources/Agents/SendDTMF' \ --header 'Authorization: Basic U2FudGlhZ286NTA5NTY3MzItYjU5ZC00MDhjLThmZmUtM2I1MDc3ZDg3Y2Zi' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'channel=1234' \ --data-urlencode 'dtmf=*1' |
Respuesta
...
Answer
The answer will always be 1 even if the parameters are not valid. It will only be 0 if an internal error occurs on the server.