Udostępnij przez


Telefonia Xtended Serv Interf (wersja zapoznawcza)

Zintegruj się z systemem telefonii BluIP, aby wykonać połączenie do następnego poziomu. Interfejs usługi telefonii Xtended (XSI).

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Obsługa funkcji BluIP
adres URL https://support.bluip.com
Email developers@bluip.com
Metadane łącznika
Publisher BluIP, Inc.
Witryna internetowa https://www.bluip.com/
Zasady ochrony prywatności https://www.bluip.com/company/legal/privacy-policy
Kategorie Produktywność; Komunikacja

Rozszerzony Interfejs Usług Telefonicznych

Zintegruj się z systemem telefonii BluIP, aby wykonać połączenie do następnego poziomu. Interfejs usługi telefonii Xtended (XSI).

Pre-requisites

Użytkownik, grupa, przedsiębiorstwo lub konto administratora systemu BluIP.

Dokumentacja interfejsu API

https://support.bluip.com

Jak uzyskać poświadczenia

Skontaktuj się z zespołem pomocy technicznej aplikacji BluIP w celu uzyskania konta demonstracyjnego lub szczegółów dotyczących bieżącego konta.

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:

Wartość domyślna Parametry tworzenia połączenia. Wszystkie regiony Nie można udostępniać

Domyślny

Dotyczy: Wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name Typ Description Wymagane
Nazwa użytkownika securestring Nazwa użytkownika masterAccess (użytkownik, grupa, przedsiębiorstwo lub administrator systemu) Prawda
Hasło securestring Hasło funkcji MasterAccess Prawda

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Blokada połączeń

Wstrzymaj połączenie.

Nieprzetworzone żądanie

Wyślij nieprzetworzone żądanie. Znajdź więcej zasobów pod adresem: https://labxsp1.masteraccess.com/com.broadsoft.xsi-actions/test/v2.0/

Nowe połączenie

Nawiązywanie połączenia

Odpowiedź na połączenie

Odpowiedz na połączenie.

Pobieranie profilu użytkownika

Pobierz profil użytkownika.

Przenoszenie połączenia

Przenieś połączenie.

Przenoszenie połączenia do poczty głosowej

Przenieś połączenie do poczty głosowej.

Przełącz nagrywanie połączeń

Przełącz stan rejestrowania wywołań.

Przełącz stan acD agenta

Przełącz stan acD agenta.

Uzyskiwanie połączeń użytkownika

Uzyskiwanie połączeń użytkownika.

Zakończenie połączenia

Zawieszanie/kończenie wywołania.

Blokada połączeń

Wstrzymaj połączenie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Identyfikator użytkownika rozwiązania BluIP.

Identyfikator połączenia
callId True string

Identyfikator wywołania połączenia.

Nieprzetworzone żądanie

Wyślij nieprzetworzone żądanie. Znajdź więcej zasobów pod adresem: https://labxsp1.masteraccess.com/com.broadsoft.xsi-actions/test/v2.0/

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId True string

Identyfikator użytkownika rozwiązania BluIP.

Zasób/ścieżka
path True string

Wybierz zasób lub wprowadź ścieżkę do zasobu.

Ładunek
payload string

Pozostaw puste wartości "GET" lub dołącz ładunek do danych "PUT".

Akceptuj
Accept string

Akceptuj

Nowe połączenie

Nawiązywanie połączenia

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userID string

Identyfikator użytkownika rozwiązania BluIP.

Numer telefonu
address True string

Numer.

Odpowiedź na połączenie

Odpowiedz na połączenie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Identyfikator użytkownika rozwiązania BluIP.

Identyfikator połączenia
callId string

Wywołaj identyfikator połączenia.

Pobieranie profilu użytkownika

Pobierz profil użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId True string

service@provider.com

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator użytkownika
details.userId string

user@bluip.com

Imię
details.firstName string

Jordania

Nazwisko
details.lastName string

Smith

Nazwisko Hirangana
details.hiranganaLastName string

Smith

Imię Hirangana
details.hiranganaFirstName string

Jordania

Nazwisko
details.nameDialingName.nameDialingLastName string

Smith

Imię
details.nameDialingName.nameDialingFirstName string

Jordania

Identyfikator grupy
details.groupId integer
Dostawca usług/identyfikator przedsiębiorstwa
details.serviceProvider string
Number
details.number integer
Extension
details.extension integer
Mobile
additionalDetails.mobile string
Identyfikator Yahoo
additionalDetails.yahooId string
Pejdżer
additionalDetails.pager string
Adres e-mail
additionalDetails.emailAddress string
Title
additionalDetails.title string
Lokalizacja
additionalDetails.location string
Dział
additionalDetails.department string
IM&P
additionalDetails.impId string
Hasło wygasa dni
passwordExpiresDays integer
FAC URI
fac string
Identyfikator URI rejestracji
registrations string
Identyfikator URI listy harmonogramu
scheduleList string
Identyfikator URI zmiany hasła portalu
portalPasswordChange string
Kod kraju
countryCode string

Przenoszenie połączenia

Przenieś połączenie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Identyfikator użytkownika rozwiązania BluIP.

Identyfikator połączenia
callId True string

Identyfikator wywołania połączenia.

Numer telefonu
address True string

Numer telefonu do przeniesienia.

Przenoszenie połączenia do poczty głosowej

Przenieś połączenie do poczty głosowej.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Identyfikator użytkownika rozwiązania BluIP.

Identyfikator połączenia
callId True string

Identyfikator wywołania połączenia.

Przełącz nagrywanie połączeń

Przełącz stan rejestrowania wywołań.

Parametry

Nazwa Klucz Wymagane Typ Opis
Akcja
action True string
Identyfikator połączenia
callId True string
Identyfikator użytkownika
userId True string

Zwraca

response
object

Przełącz stan acD agenta

Przełącz stan acD agenta.

Parametry

Nazwa Klucz Wymagane Typ Opis
Stan ACD agenta
agentACDState True string

Stan ACD agenta

Identyfikator użytkownika
userID string

Identyfikator użytkownika

Uzyskiwanie połączeń użytkownika

Uzyskiwanie połączeń użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId True string

Identyfikator użytkownika rozwiązania BluIP.

Zwraca

Nazwa Ścieżka Typ Opis
array of object
Identyfikator połączenia
callId string

Ex: callhalf-29519312843:0

URI
uri string

Np. /v2.0/user/user@provider.com/calls/callhalf-29519312843:0

Zakończenie połączenia

Zawieszanie/kończenie wywołania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Identyfikator użytkownika rozwiązania BluIP.

Identyfikator połączenia
callId True string

Identyfikator wywołania połączenia.

Wyzwalacze

Nieprzetworzona subskrypcja zdarzeń

Zdarzenia.

Podsumowanie wiadomości poczty głosowej

Reagowanie na nowe lub usunięte wiadomości poczty głosowej.

Przy zmianie nie przeszkadzać

Reagowanie na zmianę stanu DND użytkownika.

Zdarzenie przy wywołaniu

Gdy coś się stanie z wywołaniem.

Zmiana kolejki usługi Call Center

Reagowanie na wywołania w kolejce centrum obsługi telefonicznej.

Zmiana monitorowania w usłudze Call Center

Reagowanie na średni czas oczekiwania w centrum obsługi telefonicznej, wywołania a liczba agentów itp.

Zmiana stanu agenta usługi AcD agenta usługi Call Center

Reagowanie na zmianę stanu acD (automatycznej dystrybucji połączeń) agenta centrum telefonicznego.

Nieprzetworzona subskrypcja zdarzeń

Zdarzenia.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Subskrypcja na poziomie użytkownika.

Identyfikator grupy
groupId string

Subskrypcje na poziomie grupy.

Identyfikator dostawcy usług/przedsiębiorstwa
enterpriseId string

Subskrypcje na poziomie przedsiębiorstwa/dostawcy usług.

Event
event True string

Zdarzenie do subskrybowania.

Typ
type string

Określony typ zdarzenia: CallAnsweredEvent, CallReceivedEvent

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator użytkownika/elementu docelowego
targetId string

Użytkownik docelowy zdarzenia.

Event
event string

Typ zdarzenia.

Identyfikator zdarzenia
eventId string

Identyfikator zdarzenia.

Typ
type string

Typ zdarzenia.

Podsumowanie wiadomości poczty głosowej

Reagowanie na nowe lub usunięte wiadomości poczty głosowej.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Subskrypcja na poziomie użytkownika.

Identyfikator grupy
groupId string

Subskrypcje na poziomie grupy.

Identyfikator dostawcy usług/przedsiębiorstwa
enterpriseId string

Subskrypcje na poziomie przedsiębiorstwa/dostawcy usług.

Zwraca

Nazwa Ścieżka Typ Opis
Nowe wiadomości
newMessages integer

1, 2, 3 itp.

Stare wiadomości
oldMessages integer

1, 2, 3 itp.

Przy zmianie nie przeszkadzać

Reagowanie na zmianę stanu DND użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Subskrypcja na poziomie użytkownika.

Identyfikator grupy
groupId string

Subskrypcje na poziomie grupy.

Identyfikator dostawcy usług/przedsiębiorstwa
enterpriseId string

Subskrypcje na poziomie przedsiębiorstwa/dostawcy usług.

Zwraca

Nazwa Ścieżka Typ Opis
Aktywna
active boolean

true, false

Powitanie pierścienia
ringSplash boolean

true, false

Identyfikator zdarzenia
eventId string

d6986908-461e-40b9-85ca-e717851f776c

Identyfikator użytkownika/elementu docelowego
targetId string

user@bluip.com

Zdarzenie przy wywołaniu

Gdy coś się stanie z wywołaniem.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Subskrypcja na poziomie użytkownika.

Identyfikator grupy
groupId string

Subskrypcje na poziomie grupy.

Identyfikator dostawcy usług/przedsiębiorstwa
enterpriseId string

Subskrypcje na poziomie przedsiębiorstwa/dostawcy usług.

Typ
type string

Określony typ zdarzenia wywołania.

Zwraca

Nazwa Ścieżka Typ Opis
Typ
type string

CallAnsweredEvent, CallBargedInEvent, CallCollectingEvent, CallHeldEvent, HookStatusEvent, CallMonitoredEvent, CallOriginatedEvent, CallOriginatingEvent, CallPickedUpEvent, CallReceivedEvent, CallRecordingPausedEvent, CallRecordingResumedEvent, CallRecordingStartedEvent, CallRecordingStartingEvent, CallRecordingStoppedEvent, CallRedirectedEvent, CallReleasedEvent, CallReleasingEvent, CallRetrievedEvent, CallTransferredEvent, CallUpdatedEvent

Stan haka
hookStatus string

Off-Hook, On-Hook

Identyfikator zdarzenia
eventId string

d5e21e5d-7f54-4db3-8351-4302e8dbf941

Identyfikator użytkownika/elementu docelowego
targetId string

user@bluip.com

Event
event string

Połączenie zaawansowane

Identyfikator połączenia
callId string

callhalf-31126219817:0

Identyfikator śledzenia zewnętrznego
extTrackingId string

129987974:2

Identyfikator połączenia sieciowego
networkCallId string

2002829250_115291504@207.223.XX.XXX

Osobowość
personality string

Terminator, inicjator

State
state string

Alerty, Aktywne, Przechowywane, Odłączone

Godzina rozpoczęcia
startTime integer

1568204580687

Name
remoteParty.name string

Jordan Smith

Tekst
remoteParty.address.#text string

+18188675309

Kod kraju
remoteParty.address.countryCode string

1

NPA
remoteParty.address.npa string

818—XXX-XXXX

NXX
remoteParty.address.nxx string

XXX-867-XXXX

Typ wywołania
remoteParty.callType string

Sieć, grupa

Identyfikator użytkownika
remoteParty.userId string

user@bluip.com

Tekst
remoteParty.userDN.#text string

+17026904400; ext=4400

Kod kraju
remoteParty.userDN.countryCode string

1, 44 itp.

Typ
endpoint.type string

AccessEndpoint

Adres rekordu
endpoint.addressOfRecord string

user@bluip.com

Wygląd
appearance integer

1, 2 itd.

Zezwalaj na odpowiedź
allowAnswer string
Czas odpowiedzi
answerTime integer

1568204585231

Dozwolone kontrolki nagrywania
allowedRecordingControls string

brak, wstrzymywanie, wznawianie

Klasyfikacja zabezpieczeń
securityClassification string

Sklasyfikowane, niesklasyfikowane

Rejestrowane
recorded string
Stan rejestrowania
recordingState string

Rozpoczęto, wstrzymano

Zezwalaj na pobieranie
allowRetrieve string
Czas przetrzymywania
heldTime integer

1568204589829

Łączny czas przetrzymywania
totalHeldTime integer

4172

Call
call array of

Tablica wywołań, gdy więcej niż jedno wywołanie jest assosiated.

Czas odłączony
detachedTime integer

1568204605894

Czas wydania
releaseTime integer

1568204620298

Wydanie strony
releasingParty string

localRelease, remoteRelease

Tekst
redirect.address.#text string

+18188675309

Kod kraju
redirect.address.countryCode string

1, 44 itp.

Przyczyna
redirect.reason string

przenieść

Czas przekierowania
redirect.redirectTime integer

1568204605894

Zmiana kolejki usługi Call Center

Reagowanie na wywołania w kolejce centrum obsługi telefonicznej.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator grupy
groupId string

Subskrypcje na poziomie grupy.

Identyfikator dostawcy usług/przedsiębiorstwa
enterpriseId string

Subskrypcje na poziomie przedsiębiorstwa/dostawcy usług.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator połączenia
callId string

callhalf-31139148485:0

Identyfikator śledzenia zewnętrznego
extTrackingId string

130080177:2

Name
remoteParty.name string

Jordan Smith

Tekst
remoteParty.address.#text string

+18188675309

Kod kraju
remoteParty.address.countryCode string

1, 44 itp.

Typ wywołania
remoteParty.callType string

Sieć, grupa

Dodaj czas
addTime integer

1568213984179

Nazwa usługi ACD
acdName string

BluIP Demo Call Center

Tekst
acdNumber.#text string

+17026904381

Kod kraju
acdNumber.countryCode string

1, 44 itp.

Priorytet ACD
acdPriority string

3-Niski

Dodawanie czasu w zasobniku priorytetu
addTimeInPriorityBucket integer

1568213984179

Typ
type string

ACDCallAbandonedEvent, ACDCallAddedEvent, ACDCallOfferedToAgentEvent, ACDWhisperStartedEvent, Available, Sign-Out, Unavailable, Wrap-UpACDCallAnsweredByAgentEvent

Identyfikator zdarzenia
eventId string

0b5bc6c2-bc74-4234-93f9-2945aca8b215

Identyfikator użytkownika/elementu docelowego centrum obsługi telefonicznej
targetId string

BluIPCCDemo@bluip.com

Odpowiadanie na użytkownika/identyfikator docelowy
answeringUserId string

user@bluip.com

Identyfikator połączenia na odpowiedź
answeringCallId string

callhalf-31139148489:0

Usuń czas
removeTime integer

1568213990637

Zmiana monitorowania w usłudze Call Center

Reagowanie na średni czas oczekiwania w centrum obsługi telefonicznej, wywołania a liczba agentów itp.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator grupy
groupId string

Subskrypcje na poziomie grupy.

Identyfikator dostawcy usług/przedsiębiorstwa
enterpriseId string

Subskrypcje na poziomie przedsiębiorstwa/dostawcy usług.

Zwraca

Nazwa Ścieżka Typ Opis
Wartość
averageHandlingTime.value integer

0

Wartość
expectedWaitTime.value integer

0

Wartość
averageSpeedOfAnswer.value integer

14622

Wartość
longestWaitTime.value integer

5005

Wartość
numCallsInQueue.value integer

1

Liczba przypisanych agentów
numAgentsAssigned integer

1

Liczba pracowników
numAgentsStaffed integer

1

Liczba bezczynnych agentów personelu
numStaffedAgentsIdle integer

0

Liczba agentów zatrudnionych jest niedostępna
numStaffedAgentsUnavailable integer

0

Identyfikator zdarzenia
eventId string

795db7d3-1461-48dd-8a33-65cfdc9dab00

Identyfikator użytkownika/elementu docelowego centrum obsługi telefonicznej
targetId string

BluIPCCDemo@bluip.com

Zmiana stanu agenta usługi AcD agenta usługi Call Center

Reagowanie na zmianę stanu acD (automatycznej dystrybucji połączeń) agenta centrum telefonicznego.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
userId string

Subskrypcja na poziomie użytkownika.

Identyfikator grupy
groupId string

Subskrypcje na poziomie grupy.

Identyfikator dostawcy usług/przedsiębiorstwa
enterpriseId string

Subskrypcje na poziomie przedsiębiorstwa/dostawcy usług.

Zwraca

Nazwa Ścieżka Typ Opis
State
state string

Dostępne, logowanie, wylogowywanie, niedostępne, Wrap-Up

Wartość
stateTimestamp.value integer

1568212016997

Znacznik czasu logowania
signInTimestamp integer

1568212016997

Całkowity dostępny czas
totalAvailableTime integer

17, itp.

Kod niedostępny
unavailableCode integer

1, 2, 3, 4 itp.

Wartość
averageWrapUpTime.value integer

0

Identyfikator zdarzenia
eventId string

37bacb10-82a5-47ba-8a6f-f9335433e584

Identyfikator użytkownika/elementu docelowego
targetId string

user@bluip.com

Definicje

obiekt

Jest to typ "object".