Set call forward mode

Set call forward mode.

It can be used to call via P2P SIP or SIP for given numbers in the forwarding table. There are two available forward modes:

• All at once - the call is made to all numbers simultaneously
• One by one - the call is made to the numbers in turn with a delay of 20 seconds

application/json

Request Body required

• forward_mode string

  Possible values: [OneByOne, AllAtOnce]

  Forward calling mode

Responses

• 200
• 400
• 401

---

OK

• Missed json body or wrong param. Response sample:

    "error": "Wrong JSON body"
• Required field is not provided. Response sample:

    "error": "Wrong JSON body: no value for `param`"
  where param - is a required field that was not provided
• Field was of the wrong type. Response sample:

    "error": "Wrong JSON body: value `param` was of the wrong type"
  where param - is a field of the wrong type

application/json

• Schema
• Example (from schema)
• Base
• Missed param
• Wrong param type

---

Schema

• error string

  Error message

{
  "error": true
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...