Miralix REST API 6.0 - Dansk

Number of APIs: 20

Opsætning af Qodex

Dette er en Qodex Collection af Miralix REST API kald til Office Team v6.0

Hver REST API kald i denne Collection har en beskrivelse med flere detaljer.

Du har behov for at oprette et Environment eller ændre et par indstillinger i denne Collection for at få den til at virke.

Enviroment

Et Environment skal have følgende Variabler:

variable	Current Value	Beskrivelse
X-Miralix-Shared-Secret	String	Shared Secret koden er konfigureret i din Office Team profil. Uden denne virker REST API kald ikke.
httptype	https, http	Forbindelses metode. Brug http eller https. Når der skal bruges HTTPS, skal der installeres et gyldigt certifikat på serveren, hvilken ikke er en del af OfficeTeam.
IP	{server ip}, {server dns/url}	IP eller URL for Office Team Serveren
identificationType	sipUri, id, email, syncId	Hvilken identifikation metode der skal benyttes til at identificere en agent
testAgent	String	Navn på den agent du bruger som test agent.
callsQueueId	Integer	ID for den Audio kø du bruger til test.
taskQueueId	Integer	ID for den Opgave kø du bruger til test.

Collection Variabler

Ønsker man ikke at oprette et Environment, så er du muligt at bruge Collection Variabler.
Det er muligt at ændre på samme variabler som i et Environment.

Udover de variabler som også findes i Environment, så har Miralix Collection nogle ekstra variabler.
Disse variabler bliver brugt til at holde midlertidige informationer som bruges i nogen REST API kald.
Der er ikke behov for at ændre på disse variabler, da det bliver gjort automatisk.
Men du har mulighed for at ændre på variablerne hvis du ønsker og det er nødvendigt.

Der er følgende ekstra Collection Variabler:

variable	Current Value	Beskrivelse
agentId	Integer	Agent ID for den agent som REST API kaldet omhandler. Sættes/Ændres automastik når Agent oversigt kaldes i denne collection
sipUri	String	SIP URI for den agent som REST API kaldet omhandler. Sættes/Ændres automastik når Agent oversigt kaldes i denne collection
email	String	E-mail for den agent som REST API kaldet omhandler. Sættes/Ændres automastik når Agent oversigt kaldes i denne collection
syncId	String	Sync ID for den agent som REST API kaldet omhandler. Sættes/Ændres automastik når Agent oversigt kaldes i denne collection
TypeID	String	Midlertidig kopi af agentId, sipUri, email eller syncID, alt efter hvilken identificationType der er valgt. Sættes/Ændres automastik før hvert REST API kald i denne collection
QueueCallId	Integer	Midlertidig kopi af QueueCallId for det opkald der tilbydes en agent. Sættes/Ændres automastik når Oversigt over tilbudt Køkald for en bestemt agent kaldes i denne collection
TaskId	Integer	ID for en Opgave. TaskId bliver automatisk forhøjet med 1 hvergang Opret en opgave i en kø kaldes i denne collection

Vær opmærksom på

Det er nogle gange nødvendigt at først bruge en af følgende REST API kald, for at nogle bagvedliggende collection variabler bliver sat korrekt.

Agent metoder -> Agent oversigt
Henter AgentId, AgentSipUri, AgentEmail og AgentSyncId fra din testAgent, og sætter derefter variablerne agentId, sipUri, email og syncId.
Disse variabler bliver automatisk brugt som TypeID, alt efter hvilke identificationType der er valgt.

Agent metoder -> Oversigt over tilbudt Køkald for en bestemt agent
Henter QueueCallId fra det opkald der tilbydes agenten.
Denne variabel bliver brugt i pickupCall

Kø metoder -> Opret en opgave i en kø
TaskId bliver forhøjet med 1, når denne køres. Det kan havde betydning for andre opgave REST API kald

Web service i Miralix OfficeTeam v6.0

Miralix OfficeTeam tilbyder web service som interface for 3. parts applikationer (ASP.NET Web API Self-hosted) Web service kaldes via HTTP eller HTTPS kald, hvori der kan indgå en række parametre. For at aktiver Web service kræves Miralix Licens nummer 4003 (WebHooks - Event Hub).

I OfficeTeam servicen køres web service under et Atlas domæne, og kan gøres aktiv/inaktiv i konfigurationen via Miralix Wrench. Her skal der også angives en Shared Secret som er en delt nøgle der giver adgang til Web servicen.

Base URL er: https://{ip/dns}/mot/{DomainName}

På baggrund af HTTP Header Accept, så vil resultater være i JSON (application/json) eller XML-format (application/xml), standard er JSON.
Alt Dato/Tid vises i tidszone UTC+0, så visning af Dato/Tid kan konvertere til den tidszone brugeren befinder.

Alle eksemper er vist med en Base URL med HTTP. Når der skal bruges HTTPS, skal der installeres et gyldigt certifikat, hvilken ikke er en del af OfficeTeam.

Autorisation til Web service

Der skal altid være HTTP Header X-Miralix-Shared-Secret med i alle kald mod Web servicen. Dette er den delte nøgle som giver adgang.

// Eksempel
X-Miralix-Shared-Secret: IAzcGml268Z4AoFk7h98fc6gJCEo68

REST og HTTP GET, POST osv.

Der bruges HTTP POST, GET, PUT og DELETE i forbindelse med de forskellige funktioner som kan aktiveres.
* POST = Opret * GET = Læs * PUT = Opdater * DELETE = Slet

Agent metoder - Agent oversigt GET {{httptype}}://{{IP}}/mot/greenbox/agents?state=
Agent metoder - Oversigt for en bestemt agent GET {{httptype}}://{{IP}}/mot/greenbox/agents/{{identificationType}}/{{TypeID}}
Agent metoder - Oversigt over tilbudt Køkald for en bestemt agent GET {{httptype}}://{{IP}}/mot/greenbox/agents/{{identificationType}}/{{TypeID}}/busycall
Agent metoder - pickupCall POST {{httptype}}://{{IP}}/mot/greenbox/agents/{{identificationType}}/{{TypeID}}/calls/{{QueueCallId}}/pickupCall
Agent metoder - initiateOutgoingClientCall POST {{httptype}}://{{IP}}/mot/greenbox/agents/{{identificationType}}/{{TypeID}}/initiateOutgoingClientCall?ContactEndpoint=102
Agent opkald metoder - answer PUT {{httptype}}://{{IP}}/mot/greenbox/agents/{{identificationType}}/{{TypeID}}/call/answer
Agent opkald metoder - clear PUT {{httptype}}://{{IP}}/mot/greenbox/agents/{{identificationType}}/{{TypeID}}/call/clear
Agent opkald metoder - singleStepTransfer PUT {{httptype}}://{{IP}}/mot/greenbox/agents/{{identificationType}}/{{TypeID}}/call/singleStepTransfer?ContactEndpoint=103
Agent opkald metoder - consultation PUT {{httptype}}://{{IP}}/mot/greenbox/agents/{{identificationType}}/{{TypeID}}/call/Consultation?ContactEndpoint=103
Agent opkald metoder - alternate PUT {{httptype}}://{{IP}}/mot/greenbox/agents/{{identificationType}}/{{TypeID}}/call/alternate