Miralix OfficeTeam REST API 6.1 - Dansk

Number of APIs: 47

Opsætning af Qodex

Dette er en Qodex Collection af Miralix OfficeTeam REST API v6.1

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

Det er forsøgt at gøre denne collection så flexsibel som muligt. Dette er gjort ved at gøre brug af enviroments og automatisering med nogle variabler. Derudover er der oprettet tests til de fleste af REST API kaldne, for at verificere at det modtaget JSON svar er korekt.

Derfor har du 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
miralixAccount	greenbox	Miralix OfficeTeam domæne
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.
outboundCampaignId	Integer	ID for en udgående kampagne. I OfficeTeam 6.1 er alle OutboundCampaignId knyttet til 0
outboundCampaignName	String	Navn på udgående kampagne.
outboundEntryMenuId	Integer	ID for indtastningsmenu du bruger i forbindelse med en udgående kampagne.

Det er muligt at oprette flere enviroments, med forskellige variabler. For eksempel kan der oprettes et enviroments hvor der bruges https og et andet hvor der bruges http.

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 denne Collection nogle ekstra variabler.
Disse variabler bliver brugt til at holde midlertidige informationer som bruges i nogle 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øopkald 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 -> Oversigt over alle Agenter -> 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 -> Informationer på en aktiv Agent -> Oversigt over tilbudt Køkald for en bestemt agent
Henter QueueCallId fra det opkald der tilbydes agenten.
QueueCallId variabelen bliver brugt i: * Agent metoder -> Informationer på en aktiv Agent -> Pluk et kald på vegne af en agent * Kø metoder -> Informationer og styring af opkald i kø -> Slet opkald med et køopkaldsid * Kø metoder -> Informationer og styring af opkald i kø -> Slet opkald fra en bestemt kø med et køopkaldsid * Kø metoder -> Call recordings fra opkald i kø -> Hent en optagelse af et køopkald * Opkald metoder -> Opdatering af opkald -> Opdater eksisterende opkalds metadata

Kø metoder -> Tasks styring i kø -> Opret en opgave i en kø
TaskId bliver forhøjet med 1, når denne køres. Dette gøres for ikke at oprette opgaver med samme id. TaskId variabelen bliver brugt i: * Kø metoder -> Tasks styring i kø -> Opret en opgave i en kø * Opgave metoder -> Tasks styring -> Hent en bestemt opgave * Opgave metoder -> Tasks styring -> Fjern en opgave

Web service i Miralix OfficeTeam v6.1

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 (miralixAccount), 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/{miralixAccount}

HTTPS

Der skal være installeret et certifikat på serveren med domænet der laves kald på f.eks. webapi.eksempel.dk (Kan også bruges et stjerne certifikat eks: *.eksempel.dk)

Det installerede certifikat skal bindes med port 443.

Åben Certificates Store. Win+R og kør certlm.msc
Find certifikatet (Local Computer -> Personal -> Certificates) og åben det
Kopier Thumbprint til senere brug.
Åben en kommandoprompt med administrator rettigheder.
Bind certificatet til port 443 med denne kommando (udskift {Thumbprint} med dit Thumbprint):
netsh http add sslcert ipport=0.0.0.0:443 appid={B24A9EDF-5501-4C8C-A607-01D443B373CA} certhash={Thumbprint}
Der skal nu oprettes en inbound regl I Windows Firewall. Så åben “Windows Firewall with Advanced Security”.
Opret følgende inbound regl: Rule Type: Port Protocol and Ports: TCP 443 Action: Allow the connection Profile: Vælg alle profiler Navn: Miralix OfficeTeam Web Service

Det kan anbefales at gøre brug af en reverseProxy, hvis man ønsker at højne sikkerheden.

Payload data format

På baggrund af HTTP Header Accept, så vil resultater være i JSON (application/json) eller XML-format (application/xml), standard er JSON. JSON navngivning følger C# Coding Guidelines, hvor alt som udgangs punkt er PascalCasing. Dato/tid er altid i UTC + 0 tidszone og formateret ud fra ISO 8601-1:2019

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

HTTP metoder - GET, POST osv.

Der bruges HTTP GET, PUT, DELETE, POST, HEAD og PATCH i forbindelse med de forskellige funktioner som kan aktiveres.

Metode	Beskrivelse
GET	Returner den aktuelle værdi af et objekt
PUT	Udskift et objekt, eller opret et navngivet objekt, når det er relevant
DELETE	Slet et objekt
POST	Opret et nyt objekt baseret på de leverede data, eller send en kommando
HEAD	Returner metadata for et objekt til et GET-svar. Ressourcer, der understøtter GET-metoden KAN også støtte HEAD-metoden
PATCH	Anvend en delvis opdatering til et objekt

HTTP Respons koder

Der arbejdes i Miralix OfficeTeam med disse HTTP koder.

200 - OK
201 - Created
202 - Accepted
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
500 - Internal Server Error

Agent metoder-Opkalds styring for Agent - Gennemstil opkald PUT {{httptype}}://{{IP}}/mot/{{miralixAccount}}/agents/{{identificationType}}/{{TypeID}}/call/transfer
Kø metoder-Oversigt over alle køer, opkald, callback, call recordings - Oversigt over alle callback opkald GET {{httptype}}://{{IP}}/mot/{{miralixAccount}}/queues/calls/callbacks
Kø metoder-Oversigt over alle køer, opkald, callback, call recordings - Oversigt over alle optagede opkald GET {{httptype}}://{{IP}}/mot/{{miralixAccount}}/queues/calls/recordings
Kø metoder-Informationer for en bestemt kø - Oversigt over en bestemt kø GET {{httptype}}://{{IP}}/mot/{{miralixAccount}}/queues/{{callsQueueId}}
Kø metoder-Informationer for en bestemt kø - Oversigt over alle kø opkald fra en bestemt kø GET {{httptype}}://{{IP}}/mot/{{miralixAccount}}/queues/{{callsQueueId}}/calls
Kø metoder-Informationer for en bestemt kø - Oversigt over alle optagede opkald fra en bestemt kø GET {{httptype}}://{{IP}}/mot/{{miralixAccount}}/queues/{{callsQueueId}}/calls/recordings
Kø metoder-Informationer for en bestemt kø - Oversigt over alle opgaver fra en bestemt kø GET {{httptype}}://{{IP}}/mot/{{miralixAccount}}/queues/{{taskQueueId}}/tasks
Kø metoder-Informationer og styring af opkald i kø - Oversigt over alle kø opkald GET {{httptype}}://{{IP}}/mot/{{miralixAccount}}/queues/calls
Kø metoder-Informationer og styring af opkald i kø - Slet opkald med et køopkaldsid DELETE {{httptype}}://{{IP}}/mot/{{miralixAccount}}/queues/calls/{{QueueCallId}}
Kø metoder-Informationer og styring af opkald i kø - Oversigt over alle kø opkald fra en bestemt kø GET {{httptype}}://{{IP}}/mot/{{miralixAccount}}/queues/{{callsQueueId}}/calls