channels
voice
routing
call-routing-simulator

Simulate route selection

Simulates which route will be selected upon predefined request.

post/callrouting/1/routes/simulate

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Request body

tostring required

Phone number or regular expression pattern representing the phone number. Applies to all simulator endpoint types except WEBRTC. Examples: 41793026727, 41793(.+).

useDisabledRoutesboolean

If set to true, the simulator will use disabled routes for simulation. If set to false, only enabled routes will be used.

Response

Success

idstring required

Unique identifier of a route.

namestring required

Route name.

status'ENABLED' | 'DISABLED' required

Indicates whether the route is enabled or not.

orderinteger

Indicates priority index of the route. Routes with lower priority index are executed first.

transferOnlyboolean

Indicates whether this route should be used exclusively for call transfers initiated via the REFER SIP message. The to number value will be taken from the Refer-To header.

Changes

No recorded changes to this operation across all 1 revision of this API.