User Tools

Site Tools


api:mvno:account:setcfwd

API : Set call forward settings

Introduction

This request will set the call-forward settings on the mobile network, if the network is TDC.

Request

URL https://api.telecomx.dk/mvno/ACCOUNT_ID/callforward
Method POST
Access level MANAGER, OWNER if user belongs to the customer
RESELLER if customer belongs to the reseller
RESELLER_ADMIN or ADMIN
Body unconditional.enabled Boolean True to enable unconditional forward.
unconditional.number String Number to unconditionally forward to, blank if not used.
offline.enabled Boolean True to enable forward when offline.
offline.number String Number to forward to when offline, blank if not used.
busy.enabled Boolean True to enable forward when busy.
busy.number String Number to forward to when busy, blank if not used.
noAnswer.enabled Boolean True to enable forward when no answer.
noAnswer.number String Number to forward to when no answer, blank if not used.
noAnswer.timeout Number Timeout in seconds before forwarding. Valid values are: 5, 10, 15, 20, 25 and 30.

Query example

{
  unconditional: {
    enabled: false,
    number: ''
  },
  offline: {
    enabled: false,
    number: ''
  },
  busy: {
    enabled: true,
    number: '+4571919999'
  },
  noAnswer: {
    enabled: true,
    number: '+4571919999'
    timeout: 20
  }
}

Response

An array of objects each as described below.

JSON object
success Boolean True on success

Example

{
  success: true
}

Errors

Error code Message Description
400 network Wrong network, this API is only available for phones on the TDC network.
403 access_denied Insufficient access level
404 not_found Account not found
409 timeout No response from mobile network
422 unconditional.number Invalid phone number
422 offline.number Invalid phone number
422 busy.number Invalid phone number
422 noAnswer.number Invalid phone number
422 noAnswer.timeout Invalid timeout
api/mvno/account/setcfwd.txt · Last modified: 2023/06/26 09:04 by Per Møller

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki