POST | https://instance.ucontactcloud.com/Integra/resources/auth/AgentLogin |
---|---|
Content-Type | application/x-www-form-urlencoded |
Parameters | |
agent | Agent’s name |
password | Agent’s password |
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' |
The field md5secret
will be necessary to send it in the following requests, since it serves as authentication.
In case the username and/or password are incorrect, the request will return 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": "en", "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" } |
POST | https://instance.ucontactcloud.com/Integra/resources/api/AgentLogoff |
---|---|
Content-Type | application/x-www-form-urlencoded |
Parameters | |
agent | Agent’s name |
interface | Agent’s Callerid. This is obtained in the AgentLogin. |
message | Optional message to be saved in the |
Headers | |
Authorization | Basic md5secret |
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 |
Parameters | |
phone | Agent’s Callerid. This is obtained in the AgentLogin. |
Headers | |
Authorization | Basic md5secret |
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/AgentBreak |
---|---|
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 |
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/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 |
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 |
Parameters | |
callerid | Caller ID for outbound OUTDID variable. |
agent | Agent’s name |
phone | Agent’s Callerid. This is obtained in the AgentLogin. |
tech | Must always be sent like |
context | Agent context, it must be |
outqueue | Outbound campaign name |
destination | Destination phone number |
Headers | |
Authorization | Basic md5secret |
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' |
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 |
Parameters | |
channel | Call source channel |
context | Context to transfer |
exten | Extension to transfer |
Headers | |
Authorization | Basic md5secret |
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' |
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.
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 |
Parameters | |
channel | Call channel, to which you want to send the DTMF |
dtmf | DTMF value, example: *1 |
Headers | |
Authorization | Basic md5secret |
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' |
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.