GetForward

[<< go back]

Diagram

Methods

const driver = new OnlineSimDriver('APIKEY').numbers().{method}();

Example

const driver = new OnlineSimDriver('APIKEY');
const getter = driver.forward()

getter.get().then((result) => {
  console.log(result);
})

...

getter.state().then((result) => {
  console.log(result);
})
// or 
getter.stateOne(res.tzid).then((result) => {
  console.log(result);
})
...
getter.forwardingList().then((result) => {
  console.log(result);
})
...
getter.callList(res.tzid).then((result) => {
  console.log(result);
})
...
getter.close(res.tzid).then((result) => {
  console.log(result);
})

get [docs ru] [docs en]

Get new number for forward

Params	Default	Description
$forward_numbers	no	array with numbers
$service	unlimited_sms	unlimited_sms or forward_without_sms
$region	all	region
$reject	no	exclusion list

---

state [docs ru] [docs en]

Get list number for forward

Params	Default	Description
$message_to_code	1	1 - show code, 0 - show full message
$orderby	ASC	ASC or DESC
$msg_list	true	true - show all message, false show one message< need next method
$clean	true	if use msg_list===0 - false - display messages in a circle

---

stateOne [docs ru] [docs en]

Get selected number for forward

Params	Default	Description
$message_to_code	1	1 - show code, 0 - show full message
$orderby	ASC	ASC or DESC
$msg_list	true	true - show all message, false show one message< need next method
$clean	true	if use msg_list===0 - false - display messages in a circle

---

next [docs ru] [docs en]

select next message

Close selected number for service

Params	Default	Description
$tzid	no	operation id

---

close [docs ru] [docs en]

closes the operation, after closing forwarding will be enabled

Close selected number for service

Params	Default	Description
$tzid	no	operation id

---

setEnable [docs ru] [docs en]

Enable selected number for forward

Close selected number for service

Params	Default	Description
$tzid	no	operation id

---

forwardingList [docs ru] [docs en]

List active number for forward

Close selected number for service

Params	Default	Description
$tzid	no	operation id
$page	1	page number
$orderby	ASC	ASC or DESC

save [docs ru] [docs en]

Update selected number for forward

Params	Default	Description
$tzid	no	operation id
$auto	true	page number
$forward_number	no	array with numbers for forward

remove [docs ru] [docs en]

Close selected number for forward

Params	Default	Description
$tzid	no	operation id

callList [docs ru] [docs en]

History selected number for forward

Params	Default	Description
$tzid	no	operation id
$count	true	count in page
$page	1	page number
$orderby	ASC	ASC or DESC