Shared Call Appearance¶

Display user’s shared call appearance¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/shared_call_appearance/¶

Retrieve the settings of the Shared Call Appearance service of the user.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/shared_call_appearance/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
     "alertAllAppearancesForGroupPagingCalls": false,
     "allowBridgingBetweenLocations": false,
     "allowMultipleCallArrangementFeature": false,
     "allowSCACallRetrieve": false,
     "maxAppearances": 2,
     "enableCallParkNotification": false,
     "bridgeWarningTone": "None",
     "isMultipleCallArrangementServiceActive": false,
     "alertAllAppearancesForClickToDialCalls": false,
     "endpoints": [
          {
               "accessDevice": {
                    "management": false,
                    "type": "Generic SIP Phone",
                    "name": "DP_ApioUserTest",
                    "level": "Group"
               },
               "contact": "",
               "linePort": "ad@sip.netaxis.be",
               "lineNumber": 1
          }
     ]
}

Response JSON Object:

alertAllAppearancesForClickToDialCalls (boolean) – if set, the service alerts all locations for click-do-dial calls, False otherwise.
alertAllAppearancesForGroupPagingCalls (boolean) – if set, the service alerts all locations for group paging calls, False otherwise.
allowSCACallRetrieve (boolean) – if set, the user can dial a FAC to retrieve an existing active call from another location, False otherwise.
isMultipleCallArrangementServiceActive (boolean) – if True, the Multiple Call Arrangement service is active, False otherwise.
allowMultipleCallArrangementFeature (boolean) – if set, each of the user’s shared call appearance locations can be utilized while the user is on call, False otherwise.
allowBridgingBetweenLocations (boolean) – if set, one or more users can pick up the device at the user’s shared call appearance locations and barge in on the user’s current call, False otherwise.
enableCallParkNotification (boolean) – if set, the service alerts all of the user’s shared call appearance locations when a call is parked against their extension, False otherwise.
bridgeWarningTone (string) – the tone to alert all the users on a call that the call has been bridged.
maxAppearances (integer) – the maximum number of appearances that can be set.
endpoints (array) – a list of endpoint objects as defined as Endpoint Attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user

Update a user’s shared call appearance¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/shared_call_appearance/¶

Update the settings of the Shared Call Appearance service of the user.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/shared_call_appearance/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
     "alertAllAppearancesForGroupPagingCalls": true,
     "allowBridgingBetweenLocations": false,
     "allowMultipleCallArrangementFeature": true,
     "allowSCACallRetrieve": false,
     "enableCallParkNotification": true,
     "bridgeWarningTone": "Barge-In",
     "alertAllAppearancesForClickToDialCalls": false
}

Example response:

HTTP/1.1 200 OK

Request JSON Object:

alertAllAppearancesForClickToDialCalls (boolean) – (Optional) if set, the service alerts all locations for click-do-dial calls, False otherwise.
alertAllAppearancesForGroupPagingCalls (boolean) – (Optional) if set, the service alerts all locations for group paging calls, False otherwise.
allowSCACallRetrieve (boolean) – (Optional) if set, the user can dial a FAC to retrieve an existing active call from another location, False otherwise.
allowMultipleCallArrangementFeature (boolean) – (Optional) if set, each of the user’s shared call appearance locations can be utilized while the user is on call, False otherwise.
allowBridgingBetweenLocations (boolean) – (Optional) if set, one or more users can pick up the device at the user’s shared call appearance locations and barge in on the user’s current call, False otherwise.
enableCallParkNotification (boolean) – (Optional) if set, the service alerts all of the user’s shared call appearance locations when a call is parked against their extension, False otherwise.
bridgeWarningTone (string) – (Optional) the tone to alert all the users on a call that the call has been bridged.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update

Create a user’s shared call appearance endpoint¶

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/shared_call_appearance/endpoints/¶

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/shared_call_appearance/endpoint/(string: instance_name)/ (deprecated)¶

Create a new Shared Call Appearance endpoint.

The method with the instance name in the url is the old one and is deprecated and replaced by the new one inline with usual url conventions.

Example request:

POST /api/v1/tenants/foo/groups/foogroup/users/foouser/services/shared_call_appearance/endpoints/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
     "active": true,
     "allowOrigination": true,
     "allowTermination": true,
     "endpoint": {
          "accessDevice": {
               "name": "DP_ApioUserTest",
               "level": "Group"
          },
          "linePort": "ad@sip.netaxis.be"
     }
}

Example response:

HTTP/1.1 200 OK

Request JSON Object:

active (boolean) – (Optional) the status of the endpoint. Default is true.
allowOrigination (boolean) – (Optional) allow originating calls from that end point. Default is true.
allowTermination (boolean) – (Optional) allow terminating calls to that end point. Default is true.
endpoint (boolean) – see Endpoint Attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update

Display user’s shared call appearance endpoint¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/shared_call_appearance/endpoints/(string: instance_name)/¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/shared_call_appearance/endpoint/(string: instance_name)/ (deprecated)¶

Retrieve the settings of the specified Shared Call Appearance endpoint.

The method with endpoint in the url is the old one and is deprecated and replaced by the new one inline with usual url conventions.

The instance name is the linePort.

Example request:
GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/shared_call_appearance/endpoints/ad@sip.netaxis.be/ HTTP/1.1
Host: example.com
Example response:
HTTP/1.1 200 OK
Content-Type: "application/json"

{
     "active": true,
     "allowOrigination": true,
     "allowTermination": true,
     "endpoint": {
          "accessDevice": {
               "name": "DP_ApioUserTest",
               "level": "Group"
          },
          "linePort": "ad@sip.netaxis.be"
     }
}
>json boolean active:

the status of the endpoint.

>json boolean allowOrigination:

allow originating calls from that end point.

>json boolean allowTermination:

allow terminating calls to that end point.

>json boolean endpoint:

see Endpoint Attributes.

statuscode 200:

no error

statuscode 404:

the service is not assigned to the user

Update a user’s shared call appearance endpoint¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/shared_call_appearance/endpoints/(string: instance_name)/¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/shared_call_appearance/endpoint/(string: instance_name)/ (deprecated)¶

Update the settings of a Shared Call Appearance endpoint of the user.

The method with endpoint in the url is the old one and is deprecated and replaced by the new one inline with usual url conventions.

The instance name is the linePort.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/shared_call_appearance/endpoints/ad@sip.netaxis.be/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
     "active": true,
     "allowOrigination": true,
     "allowTermination": true,
     "endpoint": {
          "accessDevice": {
               "name": "DP_ApioUserTest",
               "level": "Group"
          },
          "linePort": "ad@sip.netaxis.be"
     }
}

Example response:

HTTP/1.1 200 OK

Request JSON Object:

active (boolean) – (Optional) the status of the endpoint.
allowOrigination (boolean) – (Optional) allow originating calls from that end point.
allowTermination (boolean) – (Optional) allow terminating calls to that end point.
endpoint (boolean) – see Endpoint Attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update

Delete a user’s shared call appearance endpoint(s)¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/shared_call_appearance/endpoints/¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/shared_call_appearance/ (deprecated)¶

Delete one or several Shared Call Appearance’s endpoints.

The method without endpoints in the url is the old one and is deprecated and replaced by the new one inline with usual url conventions.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/users/foouser/services/shared_call_appearance/endpoints/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
     "endpoints": [
          {
               "accessDevice": {
                    "name": "DP_ApioUserTest",
                    "level": "Group"
               },
               "linePort": "ad@sip.netaxis.be"
          }
     ]
}

Request JSON Object:

endpoints (array) – a list of endpoint objects as defined as Endpoint Attributes.

Example response:

HTTP/1.1 200 OK

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the deletion

Endpoint Attributes¶

Name	Type	Methods				Description
Name	Type	GET	POST	PUT	DELETE	Description
accessDevice	Object	A	R	R	R	An object as defined in Access Device.
linePort	String	A	R	R	R	Identifies a device endpoint in standalone mode. Must be a valid SIP URI.
contact	Array	A	O	O	O	A contact.
lineNumber	Integer	A	O	O	O	Access Device Port number value.

Access Device¶

Name	Type	Methods				Description
Name	Type	GET	POST	PUT	DELETE	Description
name	String	A	R	R	R	The name.
level	String	A	R	R	R	The level.
type	String	F	O	O	O	The type.
management	Boolean	F	O	O	O	If is of management.