共用方式為


Telephony Xtended Serv Interf (預覽版)

與 BluIP 的電話系統集成,將您的通話提升到一個新的水平。 電話語音擴展服務介面 (XSI)。

此連接器適用於以下產品和區域:

服務 Class Regions
副駕駛工作室 進階 除下列區域外的所有 Power Automate 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
邏輯應用程式 標準 所有 Logic Apps 區域, 但下列區域除外:
     - Azure Government 區域
     - Azure 中國區域
     - 美國國防部 (DoD)
Power Apps 進階 除下列區域外的所有 Power Apps 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
Power Automate(自動化服務) 進階 除下列區域外的所有 Power Automate 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
連絡人​​
名稱 BluIP 支持
URL https://support.bluip.com
Email developers@bluip.com
連接器中繼資料
Publisher BluIP 公司
網站 https://www.bluip.com/
隱私策略 https://www.bluip.com/company/legal/privacy-policy
類別 生產力;傳達

電話語音 Xtended 服務接口

與 BluIP 的電話系統集成,將您的通話提升到一個新的水平。 電話語音擴展服務介面 (XSI)。

Pre-requisites

BluIP 使用者、群組、企業或系統管理員帳戶。

API 文件

https://support.bluip.com

如何取得認證

請聯絡 BluIP 的支援團隊以取得模擬帳戶或有關您目前帳戶的詳細資訊。

正在建立連線

連接器支援下列驗證類型:

預設值 建立連線的參數。 所有區域 不可共享

預設

適用:所有地區

建立連線的參數。

這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。

名稱 類型 Description 為必填項目
用戶名稱 securestring MasterAccess 使用者名稱 (使用者、群組、企業或系統管理員)
密碼 securestring MasterAccess 密碼

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

來電接聽

接聽電話。

切換代理ACD狀態

切換客服專員 ACD 狀態。

切換通話錄音

切換通話錄音狀態。

原始請求

傳送原始要求。 在以下位置查找更多資源: https://labxsp1.masteraccess.com/com.broadsoft.xsi-actions/test/v2.0/

取得使用者呼叫

取得使用者呼叫。

將呼叫轉接至語音信箱

將呼叫轉接至語音信箱。

新通話

進行通話

獲取用戶個人資料

獲取用戶個人資料。

轉接通話

轉接通話。

通話保留

保留通話。

通話結束

掛斷/結束通話。

來電接聽

接聽電話。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId string

BluIP 使用者 ID。

通話 ID
callId string

呼叫呼叫 ID。

切換代理ACD狀態

切換客服專員 ACD 狀態。

參數

名稱 機碼 必要 類型 Description
代理ACD狀態
agentACDState True string

代理ACD狀態

使用者識別碼
userID string

使用者識別碼

切換通話錄音

切換通話錄音狀態。

參數

名稱 機碼 必要 類型 Description
行動
action True string
通話 ID
callId True string
使用者識別碼
userId True string

傳回

response
object

原始請求

傳送原始要求。 在以下位置查找更多資源: https://labxsp1.masteraccess.com/com.broadsoft.xsi-actions/test/v2.0/

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId True string

BluIP 使用者 ID。

資源/路徑
path True string

挑選資源或輸入資源的路徑。

承載
payload string

將空白保留為 “GET” 或包含承載至 “PUT” 資料。

接受
Accept string

接受

取得使用者呼叫

取得使用者呼叫。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId True string

BluIP 使用者 ID。

傳回

名稱 路徑 類型 Description
array of object
通話 ID
callId string

例如:callhalf-29519312843:0

URI
uri string

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

將呼叫轉接至語音信箱

將呼叫轉接至語音信箱。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId string

BluIP 使用者 ID。

通話 ID
callId True string

通話的通話 ID。

新通話

進行通話

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userID string

BluIP 使用者 ID。

電話號碼
address True string

電話號碼。

獲取用戶個人資料

獲取用戶個人資料。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId True string

service@provider.com

傳回

名稱 路徑 類型 Description
使用者識別碼
details.userId string

user@bluip.com

名字
details.firstName string

約旦

姓氏
details.lastName string

史密斯

希蘭加納姓氏
details.hiranganaLastName string

史密斯

希蘭加納名字
details.hiranganaFirstName string

約旦

姓氏
details.nameDialingName.nameDialingLastName string

史密斯

名字
details.nameDialingName.nameDialingFirstName string

約旦

群組識別碼
details.groupId integer
服務提供者/企業 ID
details.serviceProvider string
Number
details.number integer
Extension
details.extension integer
行動裝置
additionalDetails.mobile string
雅虎 ID
additionalDetails.yahooId string
傳呼機
additionalDetails.pager string
電子郵件地址
additionalDetails.emailAddress string
Title
additionalDetails.title string
地點
additionalDetails.location string
部門
additionalDetails.department string
IM&P(資訊與P)
additionalDetails.impId string
密碼到期天數
passwordExpiresDays integer
FAC URI
fac string
註冊 URI
registrations string
排程清單 URI
scheduleList string
入口網站密碼變更 URI
portalPasswordChange string
國碼 (地區碼)
countryCode string

轉接通話

轉接通話。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId string

BluIP 使用者 ID。

通話 ID
callId True string

通話的通話 ID。

電話號碼
address True string

要轉接至的電話號碼。

通話保留

保留通話。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId string

BluIP 使用者 ID。

通話 ID
callId True string

通話的通話 ID。

通話結束

掛斷/結束通話。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId string

BluIP 使用者 ID。

通話 ID
callId True string

通話的通話 ID。

觸發程序

原始事件訂閱

事件。

呼叫中心客服專員ACD狀態變更時

對呼叫中心客服專員的 ACD(自動呼叫分配)狀態變更做出反應。

在呼叫中心佇列變更時

對呼叫中心佇列中的呼叫做出反應。

待命活動

當通話發生問題時。

語音信箱訊息摘要

對新的或已刪除的語音郵件消息做出反應。

開啟「請勿打擾」變更

對使用者的免打擾狀態變更做出反應。

關於呼叫中心監控變化

對呼叫中心平均等待時間、呼叫與代理計數等做出反應。

原始事件訂閱

事件。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId string

使用者層級訂閱。

群組識別碼
groupId string

群組層級訂閱。

企業/服務提供者 ID
enterpriseId string

企業/服務提供者層級訂閱。

Event
event True string

要訂閱的事件。

類型
type string

特定事件類型:CallAnsweredEvent、CallReceivedEvent

傳回

名稱 路徑 類型 Description
使用者/目標ID
targetId string

事件目標使用者。

Event
event string

事件類型。

事件識別碼
eventId string

事件識別碼。

類型
type string

事件類型。

呼叫中心客服專員ACD狀態變更時

對呼叫中心客服專員的 ACD(自動呼叫分配)狀態變更做出反應。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId string

使用者層級訂閱。

群組識別碼
groupId string

群組層級訂閱。

企業/服務提供者 ID
enterpriseId string

企業/服務提供者層級訂閱。

傳回

名稱 路徑 類型 Description
State
state string

可用、登入、登出、無法使用 Wrap-Up

價值觀
stateTimestamp.value integer

1568212016997

登入時間戳記
signInTimestamp integer

1568212016997

總可用時間
totalAvailableTime integer

17 等。

無法使用的代碼
unavailableCode integer

1、2、3、4 等。

價值觀
averageWrapUpTime.value integer

0

事件識別碼
eventId string

37BACB10-82A5-47BA-8A6F-F9335433E584

使用者/目標ID
targetId string

user@bluip.com

在呼叫中心佇列變更時

對呼叫中心佇列中的呼叫做出反應。

參數

名稱 機碼 必要 類型 Description
群組識別碼
groupId string

群組層級訂閱。

企業/服務提供者 ID
enterpriseId string

企業/服務提供者層級訂閱。

傳回

名稱 路徑 類型 Description
通話 ID
callId string

callhalf-31139148485:0

外部追蹤 ID
extTrackingId string

130080177:2

名稱
remoteParty.name string

喬丹·史密斯

文字
remoteParty.address.#text string

+18188675309

國碼 (地區碼)
remoteParty.address.countryCode string

1、44 等。

通話類型
remoteParty.callType string

網絡、群組

新增時間
addTime integer

1568213984179

ACD 名稱
acdName string

BluIP 演示呼叫中心

文字
acdNumber.#text string

+17026904381

國碼 (地區碼)
acdNumber.countryCode string

1、44 等。

ACD 優先級
acdPriority string

3-低

在優先順序儲存桶中新增時間
addTimeInPriorityBucket integer

1568213984179

類型
type string

ACDCallAbandonedEvent、ACDCallAddedEvent、ACDCallOfferedToAgentEvent、ACDWhisperStartedEvent、Available、Sign-In、Sign-Out、Unavailable、Wrap-UpACDCallAnsweredByAgentEvent

事件識別碼
eventId string

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

呼叫中心使用者/目標ID
targetId string

BluIPCCDemo@bluip.com

回答使用者/目標 ID
answeringUserId string

user@bluip.com

接聽通話 ID
answeringCallId string

callhalf-31139148489:0

刪除時間
removeTime integer

1568213990637

待命活動

當通話發生問題時。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId string

使用者層級訂閱。

群組識別碼
groupId string

群組層級訂閱。

企業/服務提供者 ID
enterpriseId string

企業/服務提供者層級訂閱。

類型
type string

特定類型的通話事件。

傳回

名稱 路徑 類型 Description
類型
type string

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

掛鉤狀態
hookStatus string

摘機、掛機

事件識別碼
eventId string

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

使用者/目標ID
targetId string

user@bluip.com

Event
event string

進階通話

通話 ID
callId string

callhalf-31126219817:0

外部追蹤 ID
extTrackingId string

129987974:2

網路通話 ID
networkCallId string

2002829250_115291504@207.223.XX.XXX

人格
personality string

終結者,始祖

State
state string

警報、作用中、保留、分離

開始時間
startTime integer

1568204580687

名稱
remoteParty.name string

喬丹·史密斯

文字
remoteParty.address.#text string

+18188675309

國碼 (地區碼)
remoteParty.address.countryCode string

1

NPA
remoteParty.address.npa string

818-XXX-XXXX

NXX的
remoteParty.address.nxx string

XXX-867-XXXX

通話類型
remoteParty.callType string

網絡、群組

使用者識別碼
remoteParty.userId string

user@bluip.com

文字
remoteParty.userDN.#text string

+17026904400;分機=4400

國碼 (地區碼)
remoteParty.userDN.countryCode string

1、44 等。

類型
endpoint.type string

存取端點

記錄地址
endpoint.addressOfRecord string

user@bluip.com

外觀
appearance integer

1、2 等

允許回答
allowAnswer string
回答時間
answerTime integer

1568204585231

允許的錄製控制項
allowedRecordingControls string

無、暫停、恢復

安全分類
securityClassification string

機密、未分類

已記錄
recorded string
記錄狀態
recordingState string

已開始、已暫停

允許擷取
allowRetrieve string
保留時間
heldTime integer

1568204589829

總持有時間
totalHeldTime integer

4172

Call
call array of

關聯多個呼叫時的呼叫陣列。

超然時間
detachedTime integer

1568204605894

發布時間
releaseTime integer

1568204620298

釋放方
releasingParty string

localRelease、遠端釋放

文字
redirect.address.#text string

+18188675309

國碼 (地區碼)
redirect.address.countryCode string

1、44 等。

原因
redirect.reason string

傳送

重新導向時間
redirect.redirectTime integer

1568204605894

語音信箱訊息摘要

對新的或已刪除的語音郵件消息做出反應。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId string

使用者層級訂閱。

群組識別碼
groupId string

群組層級訂閱。

企業/服務提供者 ID
enterpriseId string

企業/服務提供者層級訂閱。

傳回

名稱 路徑 類型 Description
新訊息
newMessages integer

1、2、3等。

舊訊息
oldMessages integer

1、2、3等。

開啟「請勿打擾」變更

對使用者的免打擾狀態變更做出反應。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId string

使用者層級訂閱。

群組識別碼
groupId string

群組層級訂閱。

企業/服務提供者 ID
enterpriseId string

企業/服務提供者層級訂閱。

傳回

名稱 路徑 類型 Description
Active
active boolean

真、假

環飛濺
ringSplash boolean

真、假

事件識別碼
eventId string

D6986908-461E-40B9-85CA-E717851F776C

使用者/目標ID
targetId string

user@bluip.com

關於呼叫中心監控變化

對呼叫中心平均等待時間、呼叫與代理計數等做出反應。

參數

名稱 機碼 必要 類型 Description
群組識別碼
groupId string

群組層級訂閱。

企業/服務提供者 ID
enterpriseId string

企業/服務提供者層級訂閱。

傳回

名稱 路徑 類型 Description
價值觀
averageHandlingTime.value integer

0

價值觀
expectedWaitTime.value integer

0

價值觀
averageSpeedOfAnswer.value integer

14622

價值觀
longestWaitTime.value integer

5005

價值觀
numCallsInQueue.value integer

1

指派的客服專員數量
numAgentsAssigned integer

1

配備的代理人數
numAgentsStaffed integer

1

閒置的專員數量
numStaffedAgentsIdle integer

0

不可用的專員人數
numStaffedAgentsUnavailable integer

0

事件識別碼
eventId string

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

呼叫中心使用者/目標ID
targetId string

BluIPCCDemo@bluip.com

定義

物件

這是類型 'object'。