Route Point Properties

Announcements

Retrieve configuration

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/announcements/

Retrieve a route point’s announcement settings.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/announcements/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
   "mediaOnHoldForQueuedCalls": {
      "audioMessageSelection": "Default"
   }
}
Response JSON Object:
Status Codes:

Update configuration

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/announcements/

Update a route point’s announcement settings.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/announcements/ HTTP/1.1
Host: example.com

{
   "mediaOnHoldForQueuedCalls": {
      "audioMessageSelection": "File",
      "audioFileList": [{"name": "APIO Test Announcement"}]
   }
}
Request JSON Object:

Example response:

Response:

Similar to GET instance method response.

Status Codes:

Overflow

Retrieve configuration

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/overflow/

Retrieve a route point’s overflow settings.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/overflow/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
   "action": "Busy",
   "playAnnouncementBeforeOverflowProcessing": false,
   "overflowAfterTimeout": false,
   "timeoutSeconds": 30,
   "audioMessageSelection": "Default"
}
Response JSON Object:

  • action (string) – Value of the action to set.

  • transferPhoneNumber (string) – Phone number to transfer.

  • playAnnouncementBeforeOverflowProcessing (boolean) – Status of play announcement before overflow processing.

  • overflowAfterTimeout (boolean) – Status of overflow after timeout.

  • timeoutSeconds (integer) – Value of timeout seconds.

  • audioMessageSelection (string) – Value of the audio message selection.

  • audioFileList (array) – List of the audio file to set. See Audio File List Item.

Status Codes:

Update configuration

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/overflow/

Update a route point’s overflow settings.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/instance_statistics_reporting/ HTTP/1.1
Host: example.com

{
   "action": "Busy",
   "playAnnouncementBeforeOverflowProcessing": false,
   "overflowAfterTimeout": false,
   "timeoutSeconds": 30,
   "audioMessageSelection": "File",
   "audioFileList": [{"name": "APIO Group Test Announcement"}, {"name": "Unmodify"}, null, null]
}
Request JSON Object:

  • action (string) – Value of the action to set.

  • transferPhoneNumber (string) – Phone number to transfer.

  • playAnnouncementBeforeOverflowProcessing (boolean) – Status of play announcement before overflow processing.

  • overflowAfterTimeout (boolean) – Status of overflow after timeout.

  • timeoutSeconds (integer) – Value of timeout seconds.

  • audioMessageSelection (string) – Value of the audio message selection.

  • audioFileList (array) – List of the audio file to set. See Audio File List Item.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

Bounced Call

Retrieve configuration

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/bounced_call/

Retrieve a route point’s bounced call settings.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestCCBasic@sip.netaxis.be/bounced_call/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
   "active": true,
   "numberOfRingsBeforeBouncingCall": 5
}
Response JSON Object:

  • active (boolean) – Status of the service.

  • numberOfRingsBeforeBouncingCall (integer) – Value of number of rings before bouncing call.

  • enableTransfer (boolean) – Status of transfer.

  • transferPhoneNumber (string) – Phone Number or SIP URI to transfer.

  • bounceCallWhenAgentUnavailable (boolean) – Status of bounced call when agent unavailable.

Status Codes:

Update configuration

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/bounced_call/

Update a route point’s bounced call settings.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/bounced_call/ HTTP/1.1
Host: example.com

{
   "active": true,
   "numberOfRingsBeforeBouncingCall": 5,
   "bounceCallWhenAgentUnavailable": false
}
Request JSON Object:

  • active (boolean) – Status of the service.

  • numberOfRingsBeforeBouncingCall (integer) – Value of number of rings before bouncing call.

  • enableTransfer (boolean) – Status of transfer.

  • transferPhoneNumber (string) – Phone Number or SIP URI to transfer.

  • bounceCallWhenAgentUnavailable (boolean) – Status of bounced call when agent unavailable.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

Distinctive Ringing

Retrieve distinctive ringing configuration of a route point

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/distinctive_ringing/

Retrieve distinctive ringing configuration of a route point.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/distinctive_ringing/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
  "distinctiveRinging": false,
  "ringPatternForRoutePoint": "Short-Long-Short",
  "forceDeliveryRingPattern": "Short-Long-Short"
}
Response JSON Object:

  • distinctiveRinging (boolean) – specify if the distinctive ringing is active or not.

  • ringPatternForRoutePoint (string) – ring pattern for route point. Supported ring patterns: [‘Normal’, ‘Long-Long’, ‘Short-Short-Long’, ‘Short-Long-Short’]

  • forceDeliveryRingPattern (string) – force delivery ring pattern. Supported ring patterns: [‘Normal’, ‘Long-Long’, ‘Short-Short-Long’, ‘Short-Long-Short’]

Status Codes:

Update distinctive ringing configuration of a route point

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/distinctive_ringing/

Update distinctive ringing configuration of a route point.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/distinctive_ringing/ HTTP/1.1
Host: example.com

{
  "distinctiveRinging": false,
  "ringPatternForRoutePoint": "Short-Long-Short",
  "forceDeliveryRingPattern": "Short-Long-Short"
}
Request JSON Object:

  • distinctiveRinging (boolean) – specify if the distinctive ringing is active or not.

  • ringPatternForRoutePoint (string) – ring pattern for route point. Supported ring patterns: [‘Normal’, ‘Long-Long’, ‘Short-Short-Long’, ‘Short-Long-Short’]

  • forceDeliveryRingPattern (string) – force delivery ring pattern. Supported ring patterns: [‘Normal’, ‘Long-Long’, ‘Short-Short-Long’, ‘Short-Long-Short’]

Example response:

Response:

Similar to GET distinctive ringing instance method response.

Status Codes:

Route Points DNIS

Retrieve the route point dnis configuration.

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/dnis_config/

Retrieve the route point dnis configuration.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/dnis_config/ HTTP/1.1
Host: example.com

Example response:

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

{
  "displayDNISNumber": true,
  "displayDNISName": true
}
Response JSON Object:

  • displayDNISNumber (boolean) – Specify if to display the DNIS number of the DNIS, which received the call to agent instead of the calling number.

  • displayDNISName (boolean) – Specify to display to the agent the name of the DNIS on which the call was received instead of the calling name.

Status Codes:

Update the route point dnis configuration.

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/dnis_config/

Update the route point dnis configuration.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/dnis_config/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
  "displayDNISNumber": true,
  "displayDNISName": true
}
Request JSON Object:

  • displayDNISNumber (boolean) – (Optional) Specify if to display the DNIS number of the DNIS, which received the call to agent instead of the calling number.

  • displayDNISName (boolean) – (Optional) Specify to display to the agent the name of the DNIS on which the call was received instead of the calling name.

Example response:

Response:

Similar to GET method response.

Status Codes:

Retrieve a list of the route point’s dnis

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/dnis/

Retrieve a list of a route point’s dnis.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/footenant/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/dnis/ HTTP/1.1
Host: example.com

Example response:

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

{
  "dnis": [
      {
          "name": "Test DNIS",
          "phoneNumber": "025126780",
          "extension": "9998"
      }
  ]
}
Response JSON Object:
Status Codes:

Create a new route point dnis

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/dnis/

Create a new route point dnis.

Authorization rights: minimum Group Admin.

Example request:

POST /api/v1/tenants/footenant/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/dnis/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
  "name": "Test DNIS",
  "phoneNumber": "025126780",
  "extension": "9998",
  "useCustomCLIDSettings": true,
  "cliPhoneNumber": "025126780",
  "cliLastName": "cliLastName",
  "cliFirstName": "cliFirstName",
  "useCustomDnisAnnouncementSettings": false,
  "allowOutgoingACDCall": true
}
Request JSON Object:

Example response:

HTTP/1.1 201 CREATED
Content-Type: "application/json"

{}
Status Codes:

  • 11: ALREADY_EXISTS, “Duplicate name. The specified DNIS name is already being used by another DNIS instance.”

Retrieve a route point dnis instance

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/dnis/(string: instance_name)/

Retrieve a route point dnis instance.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/footenant/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/dnis/TestDnis/ HTTP/1.1
Host: example.com

Example response:

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

{
  "name": "TestDnis",
  "phoneNumber": "025126780",
  "extension": "9998",
  "useCustomCLIDSettings": true,
  "cliPhoneNumber": "025126780",
  "cliLastName": "cliLastName",
  "cliFirstName": "cliFirstName",
  "useCustomDnisAnnouncementSettings": false,
  "allowOutgoingACDCall": true
}
Response JSON Object:
Status Codes:

Modify the route point dnis instance

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/dnis/(string: instance_name)/

Modify the route point dnis instance.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/footenant/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/dnis/fooDnisName/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
  "name": "TestDnis",
  "phoneNumber": "025126780",
  "extension": "9998",
  "useCustomCLIDSettings": true,
  "cliPhoneNumber": "025126780",
  "cliLastName": "cliLastName",
  "cliFirstName": "cliFirstName",
  "useCustomDnisAnnouncementSettings": false,
  "allowOutgoingACDCall": true
}
Request JSON Object:

Example response:

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

{
  "name": "TestDnis",
  "phoneNumber": "025126780",
  "extension": "9998",
  "useCustomCLIDSettings": true,
  "cliPhoneNumber": "025126780",
  "cliLastName": "cliLastName",
  "cliFirstName": "cliFirstName",
  "useCustomDnisAnnouncementSettings": false,
  "allowOutgoingACDCall": true
}
Status Codes:

Remove a route point dnis instance

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/dnis/(string: instance_name)/

Remove a route point dnis instance.

Authorization rights: minimum Group Admin.

Example request:

DELETE /api/v1/tenants/footenant/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/dnis/fooDnisName/ HTTP/1.1
Host: example.com

Example response:

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

{}
Status Codes:

Retrieve the dnis announcement configuration

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/dnis_announcements/(string: instance_name)/

Retrieve a route point’s dnis announcement configuration.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/dnis_announcements/fooDnisName/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
   "mediaOnHoldForQueuedCalls": {
      "audioMessageSelection": "Default"
   }
}
Response JSON Object:
Status Codes:

Update the dnis announcement configuration

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/dnis_announcements/(string: instance_name)/

Update a route point’s dnis announcement configuration.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/dnis_announcements/fooDnisName/ HTTP/1.1
Host: example.com

{
   "mediaOnHoldForQueuedCalls": {
      "audioMessageSelection": "File",
      "audioFileList": [{"name": "APIO Test Announcement"}]
   }
}
Request JSON Object:

Example response:

Response:

Similar to GET instance method response.

Status Codes:

  • 200 OK – instance updated

  • 400 Bad Request – Bad request due to invalid parameters or dnis not found

Retrieve a list of route point’s dnis agents

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_poi,nts/(string: route_point_user_id)/dnis/(string: instance_name)/agents/

Get a list of agents who selected the DNIS as the outgoing call.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/footenant/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/dnis/fooDnisName/agents/ HTTP/1.1
Host: example.com

Example response:

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

{"agents":
  [
      {
        "userId": "ApioUserTest1@sip.netaxis.be",
        "firstName": "Test1",
        "lastName": "Test1",
        "phoneNumber": "+3225126778",
        "extension": "5001",
        "department": {
              "tenantId": "ApioGrpTest",
              "groupId": "ApioSpTest",
              "departmentName": "test_department_initial",
              "fullPathName": "test_department_parent_1 \\ test_department_initial"
        },
        "emailAddress": ""
      }
  ]
}
Response JSON Object:
Status Codes:

Route Point forced forwarding

Configure the route point to temporarily divert new incoming calls to a different route independently of the Night Service route. Forced Forwarding does not affect calls already in the queue.

Get Route Point forced forwarding

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/forced_forwarding/

Get Route Point forced forwarding configuration.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/footenant/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/forced_forwarding/ HTTP/1.1
Host: example.com

Example response:

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

{
  "active": true,
  "forwardToPhoneNumber": "+3225126779",
  "playAnnouncementBeforeForwarding": true,
  "audioMessageSelection": "File",
  "audioFileList": [
      {
          "name": "APIO Group Test Announcement"
      }
  ]
}
Response JSON Object:

  • active (boolean) – Enable the bypassing comfort messages for the route point.

  • forwardToPhoneNumber (string) – Define the number where the calls will be forwarded.

  • playAnnouncementBeforeForwarding (boolean) – Specify if an announcement should be played before forwarding a call.

  • audioMessageSelection (string) – See Announcements Config.

  • audioFileList (array) – See Announcements Config.

Status Codes:

Modify the Route Point forced forwarding

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/forced_forwarding/

Modify the Route Point forced forwarding configuration.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/footenant/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/forced_forwarding/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
  "active": true,
  "forwardToPhoneNumber": "+3225126779",
  "playAnnouncementBeforeForwarding": true,
  "audioMessageSelection": "File",
  "audioFileList": [
      {
          "name": "APIO Group Test Announcement"
      }
  ]
}
Request JSON Object:

  • active (boolean) – Enable the bypassing comfort messages for the route point.

  • forwardToPhoneNumber (string) – Define the number where the calls will be forwarded. It is mandatory when ‘active’ is True.

  • playAnnouncementBeforeForwarding (boolean) – Specify if an announcement should be played before forwarding a call.

  • audioMessageSelection (string) – See Announcements Config.

  • audioFileList (array) – See Announcements Config.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

  • 200 OK – no error

  • 400 Bad Request – Bad request due to invalid parameters, with possible sub-error codes:

  • 9: MISSING_CONDITIONAL_PARAMETERS, “The ‘forwardToPhoneNumber’ must be set in order to enable forwarding of the call.”

Route Point call disposition codes

Disposition codes are additional attributes that can be applied to inbound and outbound calls to tag calls with comments, results, and so on. More than one disposition code can be assigned to a call.

Get the list of a Route Point’s call disposition codes

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/disposition_codes/

List all the Route Point’s call disposition codes.

This list will return both the Disposition Codes specific to this instance and the ones defined at Group (in case of SP) level/Enterprise level.

Authorization rights: minimum End User.

Example request:

GET /api/v1/tenants/footenant/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/disposition_codes/ HTTP/1.1
Host: example.com

Example response:

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

{
   "disposition_codes": [
      {
         "code": "123456",
         "active": true,
         "description": "Test Call Disposition Code",
         "level": "CallCenter"
      },
      {
         "code": "5678876",
         "active": true,
         "description": "Test Call Disposition Code from Group",
         "level": "Group"
      }
   ]
}
Response JSON Object:
Status Codes:

Create a new Route Point’s call disposition code

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/disposition_codes/

Create a new Route Pointr’s call disposition code.

Authorization rights: minimum Group Admin.

Example request:

POST /api/v1/tenants/footenant/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/disposition_codes/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "code": "123456",
   "active": true,
   "description": "Test Call Disposition Code"
}
Request JSON Object:

Example response:

HTTP/1.1 201 CREATED
Content-Type: "application/json"

{}
Status Codes:

  • 11: ALREADY_EXISTS, “Disposition code name already exists.”

Get a Route Point’s call disposition code instance

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/disposition_codes/(string: instance_name)/

Get a Route Point’s call disposition code instance.

Authorization rights: minimum End User.

Example request:

GET /api/v1/tenants/footenant/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/disposition_codes/fooCode/ HTTP/1.1
Host: example.com

Example response:

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

{
   "active": true,
   "description": "Test Call Disposition Code"
}
Response JSON Object:
Status Codes:

Modify the Route Point’s call disposition code

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/disposition_codes/(string: instance_name)/

Modify the Route Point’s call disposition code.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/footenant/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/disposition_codes/fooCode/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "active": true,
   "description": "Test Call Disposition Code"
}
Request JSON Object:

Example response:

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

{}
Status Codes:

Remove a Route Point’s call disposition code

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/disposition_codes/(string: instance_name)/

Remove a Route Point’s call disposition code.

Authorization rights: minimum Group Admin.

Example request:

DELETE /api/v1/tenants/footenant/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/disposition_codes/fooCode/ HTTP/1.1
Host: example.com

Example response:

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

{}
Status Codes:

  • 200 OK – no error. Note that trying to delete an unexistent code, it’ll not return an error.

  • 400 Bad Request – Bad request due to invalid parameters, with possible sub-error codes:

  • 21: NOT_DELETED, “Cannot delete or deactivate the disposition code. It is being used as default code.”

Route Point call disposition codes settings

Get Route Point call disposition code settings

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/disposition_codes_config/

Get Route Point call disposition code settings.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/footenant/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/disposition_codes_config/ HTTP/1.1
Host: example.com

Example response:

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

{
  "enableCallDispositionCodes": true,
  "includeOrganizationCodes": true,
  "forceUseOfCallDispositionCodes": true,
  "defaultCallDispositionCode": {
      "code": "123456",
      "level": "CallCenter"
  }
}
Response JSON Object:

  • enableCallDispositionCodes (boolean) – Enable the use of the disposition codes for the route point.

  • includeOrganizationCodes (boolean) – Specify if to use the group codes in addition to route point code. To use only the route point disposition codes set to False.

  • forceUseOfCallDispositionCodes (boolean) – Force the use of disposition codes for the route point and select the default disposition code. If True, ‘defaultCallDispositionCode’ must be provided.

  • defaultCallDispositionCode (boolean) – The default disposition code to use if ‘forceUseOfCallDispositionCodes’ is enabled. See Group call center default disposition code attributes.

Status Codes:

Modify the Route Point call disposition code settings

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/route_points/call_centers/(string: route_point_user_id)/disposition_codes_config/

Modify the Route Point call disposition code settings.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/footenant/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/disposition_codes_config/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
  "enableCallDispositionCodes": true,
  "includeOrganizationCodes": true,
  "forceUseOfCallDispositionCodes": true,
  "defaultCallDispositionCode": {
      "code": "123456",
      "level": "CallCenter"
  }
}
Request JSON Object:

  • enableCallDispositionCodes (boolean) – (Optional) Enable the use of the disposition codes for the route point.

  • includeOrganizationCodes (boolean) – (Optional) Specify if to use the group codes in addition to route point code. To use only the route point disposition codes set to False.

  • forceUseOfCallDispositionCodes (boolean) – (Optional) Force the use of disposition codes for the route point and select the default disposition code. If True, ‘defaultCallDispositionCode’ must be provided.

  • defaultCallDispositionCode (boolean) – (Conditional) The default disposition code to use. It is mandatory if ‘forceUseOfCallDispositionCodes’ is enabled. Set it to null (None) to remove the actual value. See Group call center default disposition code attributes.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

  • 200 OK – no error

  • 400 Bad Request – Bad request due to invalid parameters, with possible sub-error codes:

  • 2: INVALID_PARAMETERS, “Invalid disposition code.”. Can occur if the disposition code is not active or is not existent.

  • 9: MISSING_CONDITIONAL_PARAMETERS, “When “forceUseOfCallDispositionCodes” is enabled, a default call disposition code must be provided.”