Telephony Xtended Serv Interf (プレビュー)
BluIP のテレフォニー システムと統合して、通話を次のレベルに引き上げます。 Telephony Xtended Service Interface (XSI)。
このコネクタは、次の製品および地域で利用可能です。
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | BluIP サポート |
| [URL] | https://support.bluip.com |
| メール | developers@bluip.com |
| Connector Metadata | |
|---|---|
| 発行者 | BluIP, Inc. |
| Web サイト | https://www.bluip.com/ |
| プライバシー ポリシー | https://www.bluip.com/company/legal/privacy-policy |
| カテゴリ | 通信; 生産性 |
Telephony Xtended Serv Interf
BluIP のテレフォニー システムと統合して、通話を次のレベルに引き上げます。 Telephony Xtended Service Interface (XSI)。
前提条件
BluIP ユーザー、グループ、エンタープライズ、またはシステム管理者アカウント。
API ドキュメント
資格情報の入手方法
デモ アカウントまたは現在のアカウントの詳細については、BluIP サポート チームにお問い合わせください。
接続の作成
コネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | 内容 | 必要 |
|---|---|---|---|
| ユーザー名 | securestring | MasterAccess ユーザー名 (ユーザー、グループ、エンタープライズ、またはシステム管理者) | 真 |
| パスワード | securestring | MasterAccess パスワード | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| エージェントの ACD の状態を切り替える |
エージェントの ACD の状態を切り替えます。 |
| ユーザー プロファイルの取得 |
ユーザー プロファイルを取得します。 |
| ユーザー通話を取得する |
ユーザー通話を取得します。 |
| 新しい通話 |
電話をかける |
| 生の要求 |
生の要求を送信します。 この他にも次の場所にリソースがあります: https://labxsp1.masteraccess.com/com.broadsoft.xsi-actions/test/v2.0/ |
| 通話の保留 |
通話を保留にします。 |
| 通話の終了 |
電話を切る/終了します。 |
| 通話をボイスメールに転送する |
通話をボイスメールに転送します。 |
| 通話を転送する |
通話を転送します。 |
| 通話記録を切り替える |
通話記録状態を切り替えます。 |
| 電話の応答 |
電話に応答します。 |
エージェントの ACD の状態を切り替える
エージェントの ACD の状態を切り替えます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エージェントの ACD の状態
|
agentACDState | True | string |
エージェントの ACD の状態 |
|
ユーザー ID
|
userID | string |
ユーザー ID |
戻り値
ユーザー プロファイルの取得
ユーザー プロファイルを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
User ID
|
userId | True | string |
service@provider.com |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
User ID
|
details.userId | string |
user@bluip.com |
|
First Name
|
details.firstName | string |
ヨルダン |
|
Last Name
|
details.lastName | string |
スミス |
|
姓のひらがな
|
details.hiranganaLastName | string |
スミス |
|
名のひらがな
|
details.hiranganaFirstName | string |
ヨルダン |
|
姓
|
details.nameDialingName.nameDialingLastName | string |
スミス |
|
名
|
details.nameDialingName.nameDialingFirstName | string |
ヨルダン |
|
グループ ID
|
details.groupId | integer | |
|
サービス プロバイダー/エンタープライズ ID
|
details.serviceProvider | string | |
|
数
|
details.number | integer | |
|
拡張
|
details.extension | integer | |
|
携帯電話
|
additionalDetails.mobile | string | |
|
Yahoo ID
|
additionalDetails.yahooId | string | |
|
ポケットベル
|
additionalDetails.pager | string | |
|
メール アドレス
|
additionalDetails.emailAddress | string | |
|
敬称
|
additionalDetails.title | string | |
|
場所
|
additionalDetails.location | string | |
|
部署
|
additionalDetails.department | string | |
|
IM&P
|
additionalDetails.impId | string | |
|
パスワードの有効期限
|
passwordExpiresDays | integer | |
|
FAC URI
|
fac | string | |
|
登録 URI
|
registrations | string | |
|
スケジュール リスト URI
|
scheduleList | string | |
|
ポータル パスワード URL の変更
|
portalPasswordChange | string | |
|
国コード
|
countryCode | string |
ユーザー通話を取得する
ユーザー通話を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | True | string |
BluIP ユーザー ID。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
通話 ID
|
callId | string |
例: callhalf-29519312843:0 |
|
URI
|
uri | string |
例: /v2.0/user/user@provider.com/calls/callhalf-29519312843:0 |
新しい通話
電話をかける
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userID | string |
BluIP ユーザー ID。 |
|
|
電話番号
|
address | True | string |
電話番号。 |
戻り値
生の要求
生の要求を送信します。 この他にも次の場所にリソースがあります: https://labxsp1.masteraccess.com/com.broadsoft.xsi-actions/test/v2.0/
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | True | string |
BluIP ユーザー ID。 |
|
リソース/パス
|
path | True | string |
リソースを選択するか、リソースへのパスを入力します。 |
|
ペイロード
|
payload | string |
"GET" を空白のままにするか、"PUT" データにペイロードを含めます。 |
|
|
承認
|
Accept | string |
承認 |
戻り値
通話の保留
通話を保留にします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
BluIP ユーザー ID。 |
|
|
通話 ID
|
callId | True | string |
通話の通話 ID。 |
戻り値
通話の終了
電話を切る/終了します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
BluIP ユーザー ID。 |
|
|
通話 ID
|
callId | True | string |
通話の通話 ID。 |
戻り値
通話をボイスメールに転送する
通話をボイスメールに転送します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
BluIP ユーザー ID。 |
|
|
通話 ID
|
callId | True | string |
通話の通話 ID。 |
戻り値
通話を転送する
通話を転送します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
BluIP ユーザー ID。 |
|
|
通話 ID
|
callId | True | string |
通話の通話 ID。 |
|
電話番号
|
address | True | string |
転送する電話番号。 |
戻り値
通話記録を切り替える
通話記録状態を切り替えます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
操作
|
action | True | string | |
|
通話 ID
|
callId | True | string | |
|
ユーザー ID
|
userId | True | string |
戻り値
- 応答
- object
電話の応答
電話に応答します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
BluIP ユーザー ID。 |
|
|
通話 ID
|
callId | string |
通話 ID を呼び出します。 |
戻り値
トリガー
| コール センター エージェントの ACD の状態の変更時 |
コール センター エージェントの ACD (自動着信の割り当て) の状態の変化に対応します。 |
| コール センターのキューの変更時 |
コール センターのキューの通話に対応します。 |
| コール センターの監視の変更時 |
コール センターの平均待機時間、通話対エージェント数などに対応します。 |
| ボイス メール メッセージの概要 |
新規または削除されたボイスメール メッセージに対応します。 |
| 応答不可の変更の際 |
ユーザーの DND 状態の変更に対応します。 |
| 生のイベント サブスクリプション |
イベント。 |
| 通話イベントの時 |
通話に何かが起きたとき。 |
コール センター エージェントの ACD の状態の変更時
コール センター エージェントの ACD (自動着信の割り当て) の状態の変化に対応します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
ユーザー レベル サブスクリプション。 |
|
|
グループ ID
|
groupId | string |
グループ レベル サブスクリプション。 |
|
|
エンタープライズ/サービス プロバイダー ID
|
enterpriseId | string |
エンタープライズ/サービス プロバイダーのレベル サブスクリプション。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了状態
|
state | string |
利用可能、サインイン、サインアウト、利用不可、まとめ |
|
値
|
stateTimestamp.value | integer |
1568212016997 |
|
タイムスタンプにサインインする
|
signInTimestamp | integer |
1568212016997 |
|
合計利用可能時間
|
totalAvailableTime | integer |
17 など。 |
|
使用できないコード
|
unavailableCode | integer |
1、2、3、4 など。 |
|
価値
|
averageWrapUpTime.value | integer |
0 |
|
イベント ID
|
eventId | string |
37bacb10-82a5-47ba-8a6f-f9335433e584 |
|
ユーザー/ターゲット ID
|
targetId | string |
user@bluip.com |
コール センターのキューの変更時
コール センターのキューの通話に対応します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
グループ ID
|
groupId | string |
グループ レベル サブスクリプション。 |
|
|
エンタープライズ/サービス プロバイダー ID
|
enterpriseId | string |
エンタープライズ/サービス プロバイダーのレベル サブスクリプション。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
通話 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、利用可能、サインイン、サインアウト、利用不可、Wrap-UpACDCallAnsweredByAgentEvent |
|
イベント ID
|
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 |
コール センターの監視の変更時
コール センターの平均待機時間、通話対エージェント数などに対応します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
グループ ID
|
groupId | string |
グループ レベル サブスクリプション。 |
|
|
エンタープライズ/サービス プロバイダー ID
|
enterpriseId | string |
エンタープライズ/サービス プロバイダーのレベル サブスクリプション。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
値
|
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 |
|
イベント ID
|
eventId | string |
795db7d3-1461-48dd-8a33-65cfdc9dab00 |
|
コール センターのユーザー/ターゲット ID
|
targetId | string |
BluIPCCDemo@bluip.com |
ボイス メール メッセージの概要
新規または削除されたボイスメール メッセージに対応します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
ユーザー レベル サブスクリプション。 |
|
|
グループ ID
|
groupId | string |
グループ レベル サブスクリプション。 |
|
|
エンタープライズ/サービス プロバイダー ID
|
enterpriseId | string |
エンタープライズ/サービス プロバイダーのレベル サブスクリプション。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
新しいメッセージ
|
newMessages | integer |
1、2、3 など。 |
|
古いメッセージ
|
oldMessages | integer |
1、2、3 など。 |
応答不可の変更の際
ユーザーの DND 状態の変更に対応します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
ユーザー レベル サブスクリプション。 |
|
|
グループ ID
|
groupId | string |
グループ レベル サブスクリプション。 |
|
|
エンタープライズ/サービス プロバイダー ID
|
enterpriseId | string |
エンタープライズ/サービス プロバイダーのレベル サブスクリプション。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アクティブです
|
active | boolean |
true、false |
|
リング スプラッシュ
|
ringSplash | boolean |
true、false |
|
イベント ID
|
eventId | string |
d6986908-461e-40b9-85ca-e717851f776c |
|
ユーザー/ターゲット ID
|
targetId | string |
user@bluip.com |
生のイベント サブスクリプション
イベント。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
ユーザー レベル サブスクリプション。 |
|
|
グループ ID
|
groupId | string |
グループ レベル サブスクリプション。 |
|
|
エンタープライズ/サービス プロバイダー ID
|
enterpriseId | string |
エンタープライズ/サービス プロバイダーのレベル サブスクリプション。 |
|
|
イベント
|
event | True | string |
登録するイベント。 |
|
タイプ
|
type | string |
特定のイベントの種類: CallAnsweredEvent、CallReceivedEvent |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザー/ターゲット ID
|
targetId | string |
イベントのターゲット ユーザー。 |
|
イベント
|
event | string |
イベントの種類。 |
|
イベント ID
|
eventId | string |
イベント ID。 |
|
タイプ
|
type | string |
イベントの種類。 |
通話イベントの時
通話に何かが起きたとき。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
ユーザー レベル サブスクリプション。 |
|
|
グループ ID
|
groupId | string |
グループ レベル サブスクリプション。 |
|
|
エンタープライズ/サービス プロバイダー ID
|
enterpriseId | string |
エンタープライズ/サービス プロバイダーのレベル サブスクリプション。 |
|
|
タイプ
|
type | string |
通話イベントの特定の種類。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タイプ
|
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 |
オフフック、オンフック |
|
イベント ID
|
eventId | string |
d5e21e5d-7f54-4db3-8351-4302e8dbf941 |
|
ユーザー/ターゲット ID
|
targetId | string |
user@bluip.com |
|
イベント
|
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 | 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 |
ネットワーク、グループ |
|
User ID
|
remoteParty.userId | string |
user@bluip.com |
|
Text
|
remoteParty.userDN.#text | string | |
|
Country Code
|
remoteParty.userDN.countryCode | string |
1、44 など。 |
|
タイプ
|
endpoint.type | string |
AccessEndpoint |
|
記録の住所
|
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 | array of |
複数の通話が関連付けられている場合の通話の配列。 |
|
デタッチされた時間
|
detachedTime | integer |
1568204605894 |
|
リリースされた時間
|
releaseTime | integer |
1568204620298 |
|
パーティーのリリース
|
releasingParty | string |
localRelease、remoteRelease |
|
テキスト
|
redirect.address.#text | string |
電話番号:+18188675309 |
|
国コード
|
redirect.address.countryCode | string |
1、44 など。 |
|
理由
|
redirect.reason | string |
転送 |
|
リダイレクト時間
|
redirect.redirectTime | integer |
1568204605894 |
定義
オブジェクト
’オブジェクト’ という種類です。