Integrate with BluIP's telephony system to take your call to the next level. Telephony Xtended Service Interface (XSI).
Status: Preview |
Tier: Premium |
Version: 1.0 |
Name |
Summary |
raw ([Optional]rawParameterBody body, [Optional]string Accept) |
Raw Request |
Actions |
|
Event Types |
|
Call Types |
|
Users |
|
user.calls ([internal]string Content-Type, user.callsParameterBody body, [internal]string Accept) |
Get User Calls |
Get User Profile |
|
Toggle Call Recording |
|
AgentACD States List |
|
Toggle Agent ACD State |
|
New Call |
|
Call Hold |
|
Call End |
|
Call Recording States |
|
call.TransfertoVoicemail ([Optional]call.TransfertoVoicemailParameterBody body) |
Transfer Call to Voicemail |
Transfer a Call |
|
Call Answer |
Name |
Summary |
events ([internal]string Content-Type, eventsParameterBody body) |
Raw Event Subscription |
On Do Not Disturb Change |
|
events.callCenterMonitoring (events.callCenterMonitoringParameterBody body) |
On Call Center Monitoring Change |
events.callCenterQueue (events.callCenterQueueParameterBody body) |
On Call Center Queue Change |
events.callCenterAgent (events.callCenterAgentParameterBody body) |
On Call Center Agent ACD State Change |
On Voice Mail Message Summary |
|
On Call Event |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Raw Request
Description: Send a raw request. Find more resources at: https://labxsp1.masteraccess.com/com.broadsoft.xsi-actions/test/v2.0/
Syntax:
TelephonyXtendedServInterf.raw ([Optional]rawParameterBody body, [Optional]string Accept)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
False |
|
Accept |
string (Accept)Values: [application/json, application/xml] |
Accept |
False |
Returns:
Type:rawResponse
Summary: Actions
Description: List actions in your scope.
Syntax:
TelephonyXtendedServInterf.list.actions ()
Returns:
Type:list.actionsResponse
Summary: Event Types
Description: List of event types.
Syntax:
TelephonyXtendedServInterf.list.eventTypes ()
Returns:
Summary: Call Types
Description: List of call types.
Syntax:
TelephonyXtendedServInterf.list.callTypes ()
Returns:
Summary: Users
Description: List users in your scope.
Syntax:
TelephonyXtendedServInterf.list.users ()
Returns:
Type:list.usersResponse
Summary: Get User Calls
Description: Get user calls.
Syntax:
TelephonyXtendedServInterf.user.calls ([internal]string Content-Type, user.callsParameterBody body, [internal]string Accept)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Content-Type |
string
|
|
True |
|
body |
|
|
True |
|
Accept |
string
|
|
True |
Returns:
Type:array of (user.callsResponseItem)
Summary: Get User Profile
Description: Get user profile.
Syntax:
TelephonyXtendedServInterf.user.profile (user.profileParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:user.profileResponse
Summary: Toggle Call Recording
Description: Toggle call recording state.
Syntax:
TelephonyXtendedServInterf.call.recording ([Optional]call.recordingParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
False |
Returns:
Summary: AgentACD States List
Description: List of Agent ACD States.
Syntax:
TelephonyXtendedServInterf.list.AgentACDStates ()
Returns:
Type:list.AgentACDStatesResponse
Summary: Toggle Agent ACD State
Description: Toggle the Agent ACD State.
Syntax:
TelephonyXtendedServInterf.toggle.AgentACDState ([internal]string Content-Type, [Optional]toggle.AgentACDStateParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Content-Type |
string
|
|
True |
|
body |
toggle.AgentACDStateParameterBody
|
|
False |
Returns:
Type:toggle.AgentACDStateResponse
Summary: New Call
Description: Make a call
Syntax:
TelephonyXtendedServInterf.call.New ([Optional]call.NewParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
False |
Returns:
Type:call.NewResponse
Summary: Call Hold
Description: Put a call on hold.
Syntax:
TelephonyXtendedServInterf.call.Hold ([Optional]call.HoldParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
False |
Returns:
Type:call.HoldResponse
Summary: Call End
Description: Hangup/End a call.
Syntax:
TelephonyXtendedServInterf.call.End ([Optional]call.EndParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
False |
Returns:
Type:call.EndResponse
Summary: Call Recording States
Description: Call recording states.
Syntax:
TelephonyXtendedServInterf.call.recording.states ([Optional]string Accept)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Accept |
string
|
|
False |
Returns:
Type:call.recording.statesResponse
Summary: Transfer Call to Voicemail
Description: Transfer call to voicemail.
Syntax:
TelephonyXtendedServInterf.call.TransfertoVoicemail ([Optional]call.TransfertoVoicemailParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
call.TransfertoVoicemailParameterBody
|
|
False |
Returns:
Type:call.TransfertoVoicemailResponse
Summary: Transfer a Call
Description: Transfer a call.
Syntax:
TelephonyXtendedServInterf.call.Transfer ([Optional]call.TransferParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
False |
Returns:
Summary: Call Answer
Description: Answer a call.
Syntax:
TelephonyXtendedServInterf.call.Answer ([Optional]call.AnswerParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
False |
Returns:
Type:call.AnswerResponse
Summary: Raw Event Subscription
Description: Events.
Syntax:
TelephonyXtendedServInterf.events ([internal]string Content-Type, eventsParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Content-Type |
string
|
|
True |
|
body |
|
|
True |
Returns:
Type:eventsResponse
Summary: On Do Not Disturb Change
Description: React to a user's DND state change.
Syntax:
TelephonyXtendedServInterf.events.doNotDisturb (events.doNotDisturbParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
events.doNotDisturbParameterBody
|
|
True |
Returns:
Type:events.doNotDisturbResponse
Summary: On Call Center Monitoring Change
Description: React to call center average wait time, calls vs. agent count, etc.
Syntax:
TelephonyXtendedServInterf.events.callCenterMonitoring (events.callCenterMonitoringParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
events.callCenterMonitoringParameterBody
|
|
True |
Returns:
Type:events.callCenterMonitoringResponse
Summary: On Call Center Queue Change
Description: React to calls in a call center queue.
Syntax:
TelephonyXtendedServInterf.events.callCenterQueue (events.callCenterQueueParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
events.callCenterQueueParameterBody
|
|
True |
Returns:
Type:events.callCenterQueueResponse
Summary: On Call Center Agent ACD State Change
Description: React to a call center agent's ACD (Automatic Call Distribution) state change.
Syntax:
TelephonyXtendedServInterf.events.callCenterAgent (events.callCenterAgentParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
events.callCenterAgentParameterBody
|
|
True |
Returns:
Type:events.callCenterAgentResponse
Summary: On Voice Mail Message Summary
Description: React to new or removed voicemail messages.
Syntax:
TelephonyXtendedServInterf.events.voicemail (events.voicemailParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Summary: On Call Event
Description: When something happens to a call.
Syntax:
TelephonyXtendedServInterf.events.call (events.callParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:events.callResponse
Summary:
Description:
Properties:
Name |
Type |
Summary |
userId |
string
|
A BluIP User ID. |
callId |
string
|
Call Call ID. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
userId |
string
|
A BluIP User ID. |
callId |
string
|
Call ID of a call. |
decline |
string
|
decline |
declineReason |
string
|
declineReason |
allowDetached |
string
|
allowDetached |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
userId |
string
|
A BluIP User ID. |
callId |
string
|
Call ID of a call. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
userID |
string
|
A BluIP User ID. |
pin |
string
|
pin |
location |
string
|
location |
clId |
string
|
clId |
address |
string
|
Phone number. |
roomId |
string
|
roomId |
conferenceId |
string
|
conferenceId |
locationAddress |
string
|
locationAddress |
info |
string
|
info |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
summary |
string
|
summary |
description |
string
|
description |
operationId |
string
|
operationId |
parameters |
array of (ParametersItem)
|
parameters |
responses |
|
responses |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
name |
value |
string
|
value |
Summary:
Description: responses
Properties:
Name |
Type |
Summary |
200 |
|
200 |
default |
|
default |
Summary:
Description: 200
Properties:
Name |
Type |
Summary |
description |
string
|
description |
schema |
|
schema |
Summary:
Description: schema
Properties:
Name |
Type |
Summary |
type |
string
|
type |
Summary:
Description: default
Properties:
Name |
Type |
Summary |
description |
string
|
description |
Summary:
Description:
Properties:
Name |
Type |
Summary |
action |
string
|
|
callId |
string
|
|
userId |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
userId |
string
|
A BluIP User ID. |
callId |
string
|
Call ID of a call. |
address |
string
|
Phone number to transfer to. |
toFront |
string
|
toFront |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
userId |
string
|
A BluIP User ID. |
callId |
string
|
Call ID of a call. |
address |
string
|
address |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
userId |
string
|
User level subscription. |
groupId |
string
|
Group level subscriptions. |
enterpriseId |
string
|
Enterprise/Service Provider level subscriptions. |
event |
string
|
event |
notificationUrl |
string
|
notificationUrl |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
groupId |
string
|
Group level subscriptions. |
enterpriseId |
string
|
Enterprise/Service Provider level subscriptions. |
event |
string
|
event |
notificationUrl |
string
|
notificationUrl |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
groupId |
string
|
Group level subscriptions. |
enterpriseId |
string
|
Enterprise/Service Provider level subscriptions. |
event |
string
|
event |
notificationUrl |
string
|
notificationUrl |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
userId |
string
|
User level subscription. |
groupId |
string
|
Group level subscriptions. |
enterpriseId |
string
|
Enterprise/Service Provider level subscriptions. |
event |
string
|
event |
type |
string
|
Specific type of call event. |
notificationUrl |
string
|
notificationUrl |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
userId |
string
|
User level subscription. |
groupId |
string
|
Group level subscriptions. |
enterpriseId |
string
|
Enterprise/Service Provider level subscriptions. |
event |
string
|
event |
notificationUrl |
string
|
notificationUrl |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
userId |
string
|
User level subscription. |
groupId |
string
|
Group level subscriptions. |
enterpriseId |
string
|
Enterprise/Service Provider level subscriptions. |
event |
string
|
event |
notificationUrl |
string
|
notificationUrl |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
userId |
string
|
User level subscription. |
groupId |
string
|
Group level subscriptions. |
enterpriseId |
string
|
Enterprise/Service Provider level subscriptions. |
event |
string
|
Event to subscribe to. |
type |
string
|
Specific type of event: CallAnsweredEvent, CallReceivedEvent |
notificationUrl |
string
|
notificationUrl |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
summary |
string
|
summary |
description |
string
|
description |
operationId |
string
|
operationId |
parameters |
array of (ParametersItem)
|
parameters |
responses |
|
responses |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
name |
value |
string
|
value |
Summary:
Description: responses
Properties:
Name |
Type |
Summary |
200 |
|
200 |
default |
|
default |
Summary:
Description: 200
Properties:
Name |
Type |
Summary |
description |
string
|
description |
schema |
|
schema |
Summary:
Description: schema
Properties:
Name |
Type |
Summary |
type |
string
|
type |
Summary:
Description: default
Properties:
Name |
Type |
Summary |
description |
string
|
description |
Summary:
Description:
Properties:
Name |
Type |
Summary |
summary |
string
|
summary |
description |
string
|
description |
operationId |
string
|
operationId |
parameters |
array of (ParametersItem)
|
parameters |
responses |
|
responses |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
name |
value |
string
|
value |
Summary:
Description: responses
Properties:
Name |
Type |
Summary |
200 |
|
200 |
default |
|
default |
Summary:
Description: 200
Properties:
Name |
Type |
Summary |
description |
string
|
description |
schema |
|
schema |
Summary:
Description: schema
Properties:
Name |
Type |
Summary |
type |
string
|
type |
Summary:
Description: default
Properties:
Name |
Type |
Summary |
description |
string
|
description |
Summary:
Description:
Properties:
Name |
Type |
Summary |
summary |
string
|
summary |
description |
string
|
description |
operationId |
string
|
operationId |
parameters |
array of (ParametersItem)
|
parameters |
responses |
|
responses |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
name |
value |
string
|
value |
Summary:
Description: responses
Properties:
Name |
Type |
Summary |
200 |
|
200 |
default |
|
default |
Summary:
Description: 200
Properties:
Name |
Type |
Summary |
description |
string
|
description |
schema |
|
schema |
Summary:
Description: schema
Properties:
Name |
Type |
Summary |
type |
string
|
type |
Summary:
Description: default
Properties:
Name |
Type |
Summary |
description |
string
|
description |
Summary:
Description:
Properties:
Name |
Type |
Summary |
summary |
string
|
summary |
description |
string
|
description |
operationId |
string
|
operationId |
parameters |
array of (ParametersItem)
|
parameters |
responses |
|
responses |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
name |
value |
string
|
value |
Summary:
Description: responses
Properties:
Name |
Type |
Summary |
200 |
|
200 |
default |
|
default |
Summary:
Description: 200
Properties:
Name |
Type |
Summary |
description |
string
|
description |
schema |
|
schema |
Summary:
Description: schema
Properties:
Name |
Type |
Summary |
type |
string
|
type |
Summary:
Description: default
Properties:
Name |
Type |
Summary |
description |
string
|
description |
Summary:
Description:
Properties:
Name |
Type |
Summary |
summary |
string
|
summary |
description |
string
|
description |
operationId |
string
|
operationId |
parameters |
array of (ParametersItem)
|
parameters |
responses |
|
responses |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
name |
value |
string
|
value |
Summary:
Description: responses
Properties:
Name |
Type |
Summary |
200 |
|
200 |
default |
|
default |
Summary:
Description: 200
Properties:
Name |
Type |
Summary |
description |
string
|
description |
schema |
|
schema |
Summary:
Description: schema
Properties:
Name |
Type |
Summary |
type |
string
|
type |
Summary:
Description: default
Properties:
Name |
Type |
Summary |
description |
string
|
description |
Summary:
Description:
Properties:
Name |
Type |
Summary |
userId |
string User ID |
A BluIP User ID. |
path |
string
|
Pick a resource or enter the path to a resource. |
payload |
string
|
Leave empty to "GET" or include payload to "PUT" data. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
agentACDState |
string
|
Agent ACD State |
userID |
string
|
User ID |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
userId |
string
|
A BluIP User ID. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
callId |
string
|
Ex: callhalf-29519312843:0 |
uri |
string
|
Ex: /v2.0/user/user@provider.com/calls/callhalf-29519312843:0 |
Summary:
Description:
Properties:
Name |
Type |
Summary |
userId |
string
|
service@provider.com |
Summary:
Description:
Properties:
Name |
Type |
Summary |
details |
|
|
additionalDetails |
|
|
passwordExpiresDays |
integer(int32)
|
|
fac |
string
|
|
registrations |
string
|
|
scheduleList |
string
|
|
portalPasswordChange |
string
|
|
countryCode |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
userId |
string
|
user@bluip.com |
firstName |
string
|
Jordan |
lastName |
string
|
Smith |
hiranganaLastName |
string
|
Smith |
hiranganaFirstName |
string
|
Jordan |
nameDialingName |
|
|
groupId |
integer
|
|
serviceProvider |
string
|
|
number |
integer(int32)
|
|
extension |
integer(int32)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
nameDialingLastName |
string
|
Smith |
nameDialingFirstName |
string
|
Jordan |
Summary:
Description:
Properties:
Name |
Type |
Summary |
mobile |
string
|
|
yahooId |
string
|
|
pager |
string
|
|
emailAddress |
string
|
|
title |
string
|
|
location |
string
|
|
department |
string
|
|
impId |
string
|
|