Telephony Xtended Serv Interf (Preview)
Integrate with BluIP's telephony system to take your call to the next level. Telephony Xtended Service Interface (XSI).
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | BluIP Support |
| URL | https://support.bluip.com |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | BluIP, Inc. |
| Website | https://www.bluip.com/ |
| Privacy policy | https://www.bluip.com/company/legal/privacy-policy |
| Categories | Productivity;Communication |
Telephony Xtended Serv Interf
Integrate with BluIP's telephony system to take your call to the next level. Telephony Xtended Service Interface (XSI).
Pre-requisites
A BluIP user, group, enterprise, or system admin account.
API documentation
How to get credentials
Contact BluIP's support team for a demo account or details about your current account.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Username | securestring | MasterAccess Username (User, Group, Enterprise, or System Admin) | True |
| Password | securestring | MasterAccess Password | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Call Answer |
Answer a call. |
| Call End |
Hangup/End a call. |
| Call Hold |
Put a call on hold. |
| Get User Calls |
Get user calls. |
| Get User Profile |
Get user profile. |
| New Call |
Make a call |
| Raw Request |
Send a raw request. Find more resources at: https://labxsp1.masteraccess.com/com.broadsoft.xsi-actions/test/v2.0/ |
| Toggle Agent ACD State |
Toggle the Agent ACD State. |
| Toggle Call Recording |
Toggle call recording state. |
| Transfer a Call |
Transfer a call. |
| Transfer Call to Voicemail |
Transfer call to voicemail. |
Call Answer
Answer a call.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
userId | string |
A BluIP User ID. |
|
|
Call ID
|
callId | string |
Call Call ID. |
Returns
Call End
Hangup/End a call.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
userId | string |
A BluIP User ID. |
|
|
Call ID
|
callId | True | string |
Call ID of a call. |
Returns
Call Hold
Put a call on hold.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
userId | string |
A BluIP User ID. |
|
|
Call ID
|
callId | True | string |
Call ID of a call. |
Returns
Get User Calls
Get user calls.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
userId | True | string |
A BluIP User ID. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Call ID
|
callId | string |
Ex: callhalf-29519312843:0 |
|
URI
|
uri | string |
Ex: /v2.0/user/[email protected]/calls/callhalf-29519312843:0 |
Get User Profile
Get user profile.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
userId | True | string |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
User ID
|
details.userId | string | |
|
First Name
|
details.firstName | string |
Jordan |
|
Last Name
|
details.lastName | string |
Smith |
|
Hirangana Last Name
|
details.hiranganaLastName | string |
Smith |
|
Hirangana First Name
|
details.hiranganaFirstName | string |
Jordan |
|
Last Name
|
details.nameDialingName.nameDialingLastName | string |
Smith |
|
First Name
|
details.nameDialingName.nameDialingFirstName | string |
Jordan |
|
Group ID
|
details.groupId | integer | |
|
Service Provider/Enterprise ID
|
details.serviceProvider | string | |
|
Number
|
details.number | integer | |
|
Extension
|
details.extension | integer | |
|
Mobile
|
additionalDetails.mobile | string | |
|
Yahoo ID
|
additionalDetails.yahooId | string | |
|
Pager
|
additionalDetails.pager | string | |
|
Email Address
|
additionalDetails.emailAddress | string | |
|
Title
|
additionalDetails.title | string | |
|
Location
|
additionalDetails.location | string | |
|
Department
|
additionalDetails.department | string | |
|
IM&P
|
additionalDetails.impId | string | |
|
Password Expires Days
|
passwordExpiresDays | integer | |
|
FAC URI
|
fac | string | |
|
Registrations URI
|
registrations | string | |
|
Schedule List URI
|
scheduleList | string | |
|
Portal Password Change URI
|
portalPasswordChange | string | |
|
Country Code
|
countryCode | string |
New Call
Make a call
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
userID | string |
A BluIP User ID. |
|
|
Phone Number
|
address | True | string |
Phone number. |
Returns
Raw Request
Send a raw request. Find more resources at: https://labxsp1.masteraccess.com/com.broadsoft.xsi-actions/test/v2.0/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
userId | True | string |
A BluIP User ID. |
|
Resource/Path
|
path | True | string |
Pick a resource or enter the path to a resource. |
|
Payload
|
payload | string |
Leave empty to "GET" or include payload to "PUT" data. |
|
|
Accept
|
Accept | string |
Accept |
Returns
Toggle Agent ACD State
Toggle the Agent ACD State.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Agent ACD State
|
agentACDState | True | string |
Agent ACD State |
|
User ID
|
userID | string |
User ID |
Returns
Toggle Call Recording
Toggle call recording state.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Action
|
action | True | string | |
|
Call ID
|
callId | True | string | |
|
User ID
|
userId | True | string |
Returns
- response
- object
Transfer a Call
Transfer a call.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
userId | string |
A BluIP User ID. |
|
|
Call ID
|
callId | True | string |
Call ID of a call. |
|
Phone Number
|
address | True | string |
Phone number to transfer to. |
Returns
Transfer Call to Voicemail
Transfer call to voicemail.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
userId | string |
A BluIP User ID. |
|
|
Call ID
|
callId | True | string |
Call ID of a call. |
Returns
Triggers
| On Call Center Agent ACD State Change |
React to a call center agent's ACD (Automatic Call Distribution) state change. |
| On Call Center Monitoring Change |
React to call center average wait time, calls vs. agent count, etc. |
| On Call Center Queue Change |
React to calls in a call center queue. |
| On Call Event |
When something happens to a call. |
| On Do Not Disturb Change |
React to a user's DND state change. |
| On Voice Mail Message Summary |
React to new or removed voicemail messages. |
| Raw Event Subscription |
Events. |
On Call Center Agent ACD State Change
React to a call center agent's ACD (Automatic Call Distribution) state change.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
userId | string |
User level subscription. |
|
|
Group ID
|
groupId | string |
Group level subscriptions. |
|
|
Enterprise/Service Provider ID
|
enterpriseId | string |
Enterprise/Service Provider level subscriptions. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
State
|
state | string |
Available, Sign-In, Sign-Out, Unavailable, Wrap-Up |
|
Value
|
stateTimestamp.value | integer |
1568212016997 |
|
Sign In Timestamp
|
signInTimestamp | integer |
1568212016997 |
|
Total Available Time
|
totalAvailableTime | integer |
17, etc. |
|
Unavailable Code
|
unavailableCode | integer |
1, 2, 3, 4, etc. |
|
Value
|
averageWrapUpTime.value | integer |
0 |
|
Event ID
|
eventId | string |
37bacb10-82a5-47ba-8a6f-f9335433e584 |
|
User/Target ID
|
targetId | string |
On Call Center Monitoring Change
React to call center average wait time, calls vs. agent count, etc.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Group ID
|
groupId | string |
Group level subscriptions. |
|
|
Enterprise/Service Provider ID
|
enterpriseId | string |
Enterprise/Service Provider level subscriptions. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
averageHandlingTime.value | integer |
0 |
|
Value
|
expectedWaitTime.value | integer |
0 |
|
Value
|
averageSpeedOfAnswer.value | integer |
14622 |
|
Value
|
longestWaitTime.value | integer |
5005 |
|
Value
|
numCallsInQueue.value | integer |
1 |
|
Number of Agents Assigned
|
numAgentsAssigned | integer |
1 |
|
Number of Agents Staffed
|
numAgentsStaffed | integer |
1 |
|
Number of Staffed Agents Idle
|
numStaffedAgentsIdle | integer |
0 |
|
Number of Staffed Agents Unavailable
|
numStaffedAgentsUnavailable | integer |
0 |
|
Event ID
|
eventId | string |
795db7d3-1461-48dd-8a33-65cfdc9dab00 |
|
Call Center User/Target ID
|
targetId | string |
On Call Center Queue Change
React to calls in a call center queue.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Group ID
|
groupId | string |
Group level subscriptions. |
|
|
Enterprise/Service Provider ID
|
enterpriseId | string |
Enterprise/Service Provider level subscriptions. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Call ID
|
callId | string |
callhalf-31139148485:0 |
|
External Tracking ID
|
extTrackingId | string |
130080177:2 |
|
Name
|
remoteParty.name | string |
Jordan Smith |
|
Text
|
remoteParty.address.#text | string | |
|
Country Code
|
remoteParty.address.countryCode | string |
1, 44, etc. |
|
Call Type
|
remoteParty.callType | string |
Network, Group |
|
Add Time
|
addTime | integer |
1568213984179 |
|
ACD Name
|
acdName | string |
BluIP Demo Call Center |
|
Text
|
acdNumber.#text | string | |
|
Country Code
|
acdNumber.countryCode | string |
1, 44, etc. |
|
ACD Priority
|
acdPriority | string |
3-Low |
|
Add Time In Priority Bucket
|
addTimeInPriorityBucket | integer |
1568213984179 |
|
Type
|
type | string |
ACDCallAbandonedEvent, ACDCallAddedEvent, ACDCallOfferedToAgentEvent, ACDWhisperStartedEvent,Available, Sign-In, Sign-Out, Unavailable, Wrap-UpACDCallAnsweredByAgentEvent |
|
Event ID
|
eventId | string |
0b5bc6c2-bc74-4234-93f9-2945aca8b215 |
|
Call Center User/Target ID
|
targetId | string | |
|
Answering User/Target ID
|
answeringUserId | string | |
|
Answering Call ID
|
answeringCallId | string |
callhalf-31139148489:0 |
|
Remove Time
|
removeTime | integer |
1568213990637 |
On Call Event
When something happens to a call.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
userId | string |
User level subscription. |
|
|
Group ID
|
groupId | string |
Group level subscriptions. |
|
|
Enterprise/Service Provider ID
|
enterpriseId | string |
Enterprise/Service Provider level subscriptions. |
|
|
Type
|
type | string |
Specific type of call event. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Type
|
type | string |
CallAnsweredEvent, CallBargedInEvent, CallCollectingEvent, CallHeldEvent, HookStatusEvent, CallMonitoredEvent, CallOriginatedEvent, CallOriginatingEvent, CallPickedUpEvent, CallReceivedEvent, CallRecordingPausedEvent, CallRecordingResumedEvent, CallRecordingStartedEvent, CallRecordingStartingEvent, CallRecordingStoppedEvent, CallRedirectedEvent, CallReleasedEvent, CallReleasingEvent, CallRetrievedEvent, CallTransferredEvent, CallUpdatedEvent |
|
Hook Status
|
hookStatus | string |
Off-Hook, On-Hook |
|
Event ID
|
eventId | string |
d5e21e5d-7f54-4db3-8351-4302e8dbf941 |
|
User/Target ID
|
targetId | string | |
|
Event
|
event | string |
Advanced Call |
|
Call ID
|
callId | string |
callhalf-31126219817:0 |
|
External Tracking ID
|
extTrackingId | string |
129987974:2 |
|
Network Call ID
|
networkCallId | string | |
|
Personality
|
personality | string |
Terminator, Originator |
|
State
|
state | string |
Alerting, Active, Held, Detached |
|
Start Time
|
startTime | integer |
1568204580687 |
|
Name
|
remoteParty.name | string |
Jordan Smith |
|
Text
|
remoteParty.address.#text | string | |
|
Country Code
|
remoteParty.address.countryCode | string |
1 |
|
NPA
|
remoteParty.address.npa | string |
818-XXX-XXXX |
|
NXX
|
remoteParty.address.nxx | string |
XXX-867-XXXX |
|
Call Type
|
remoteParty.callType | string |
Network, Group |
|
User ID
|
remoteParty.userId | string | |
|
Text
|
remoteParty.userDN.#text | string | |
|
Country Code
|
remoteParty.userDN.countryCode | string |
1, 44, etc. |
|
Type
|
endpoint.type | string |
AccessEndpoint |
|
Address of Record
|
endpoint.addressOfRecord | string | |
|
Appearance
|
appearance | integer |
1, 2, etc. |
|
Allow Answer
|
allowAnswer | string | |
|
Answer Time
|
answerTime | integer |
1568204585231 |
|
Allowed Recording Controls
|
allowedRecordingControls | string |
none, pause, resume |
|
Security Classification
|
securityClassification | string |
Classified, Unclassified |
|
Recorded
|
recorded | string | |
|
Recording State
|
recordingState | string |
Started, Paused |
|
Allow Retrieve
|
allowRetrieve | string | |
|
Held Time
|
heldTime | integer |
1568204589829 |
|
Total Held Time
|
totalHeldTime | integer |
4172 |
|
Call
|
call | array of |
Array of calls when more than one call is assosiated. |
|
Detached Time
|
detachedTime | integer |
1568204605894 |
|
Release Time
|
releaseTime | integer |
1568204620298 |
|
Releasing Party
|
releasingParty | string |
localRelease, remoteRelease |
|
Text
|
redirect.address.#text | string | |
|
Country Code
|
redirect.address.countryCode | string |
1, 44, etc. |
|
Reason
|
redirect.reason | string |
transfer |
|
Redirect Time
|
redirect.redirectTime | integer |
1568204605894 |
On Do Not Disturb Change
React to a user's DND state change.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
userId | string |
User level subscription. |
|
|
Group ID
|
groupId | string |
Group level subscriptions. |
|
|
Enterprise/Service Provider ID
|
enterpriseId | string |
Enterprise/Service Provider level subscriptions. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Active
|
active | boolean |
true, false |
|
Ring Splash
|
ringSplash | boolean |
true, false |
|
Event ID
|
eventId | string |
d6986908-461e-40b9-85ca-e717851f776c |
|
User/Target ID
|
targetId | string |
On Voice Mail Message Summary
React to new or removed voicemail messages.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
userId | string |
User level subscription. |
|
|
Group ID
|
groupId | string |
Group level subscriptions. |
|
|
Enterprise/Service Provider ID
|
enterpriseId | string |
Enterprise/Service Provider level subscriptions. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
New Messages
|
newMessages | integer |
1, 2, 3, etc. |
|
Old Messages
|
oldMessages | integer |
1, 2, 3, etc. |
Raw Event Subscription
Events.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
userId | string |
User level subscription. |
|
|
Group ID
|
groupId | string |
Group level subscriptions. |
|
|
Enterprise/Service Provider ID
|
enterpriseId | string |
Enterprise/Service Provider level subscriptions. |
|
|
Event
|
event | True | string |
Event to subscribe to. |
|
Type
|
type | string |
Specific type of event: CallAnsweredEvent, CallReceivedEvent |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
User/Target ID
|
targetId | string |
Event target user. |
|
Event
|
event | string |
Event type. |
|
Event ID
|
eventId | string |
The event ID. |
|
Type
|
type | string |
Event type. |
Definitions
object
This is the type 'object'.