| orderDIDInternationalTollFree | |
| Parameters |
location_id => [Required] ID for a specific International Location
(Values from getDIDsInternationalTollFree)
quantity => [Required] Number of dids to be purchased (Example: 2)
routing => [Required] Main Routing for the DID
failover_busy => Busy Routing for the DID
failover_unreachable => Unreachable Routing for the DID
failover_noanswer => NoAnswer Routing for the DID
voicemail => Voicemail for the DID (Example: 101)
pop => [Required] Point of Presence for the DID (Example: 5)
dialtime => [Required] Dial Time Out for the DID (Example: 60 -> in seconds)
cnam => [Required] CNAM for the DID (Boolean: 1/0)
callerid_prefix => Caller ID Prefix for the DID
note => Note for the DID
account => Reseller Sub Account (Example: '100001_VoIP')
monthly => Montly Fee for Reseller Client (Example: 3.50)
setup => Setup Fee for Reseller Client (Example: 1.99)
minute => Minute Rate for Reseller Client (Example: 0.03)
test => Set to true if testing how Orders work
- Orders can not be undone
- When testing, no Orders are made
routing, failover_busy, failover_unreachable and failover_noanswer
can receive values in the following format => header:record_id
Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none.
Examples:
account Used for routing calls to Sub Accounts
You can get all sub accounts using the getSubAccounts function
fwd Used for routing calls to Forwarding entries.
You can get the ID right after creating a Forwarding with setForwarding
or by requesting all forwardings entries with getForwardings.
vm Used for routing calls to a Voicemail.
You can get all voicemails and their IDs using the getVoicemails function
sys System Options:
hangup = Hangup the Call
busy = Busy tone
noservice = System Recording: Number not in service
disconnected = System Recording: Number has been disconnected
dtmf = DTMF Test
echo = ECHO Test
none Used to route calls to no action
Examples:
'account:100001_VoIP'
'fwd:1026'
'vm:101'
'none:'
'sys:echo'
|
| Output |
Array
(
[status] => success
)
|
| orderDIDVirtual | |
| Parameters |
digits => [Required] Three Digits for the new Virtual DID (Example: 001)
routing => [Required] Main Routing for the DID
failover_busy => Busy Routing for the DID
failover_unreachable => Unreachable Routing for the DID
failover_noanswer => NoAnswer Routing for the DID
voicemail => Voicemail for the DID (Example: 101)
pop => [Required] Point of Presence for the DID (Example: 5)
dialtime => [Required] Dial Time Out for the DID (Example: 60 -> in seconds)
cnam => [Required] CNAM for the DID (Boolean: 1/0)
callerid_prefix => Caller ID Prefix for the DID
note => Note for the DID
account => Reseller Sub Account (Example: '100001_VoIP')
monthly => Montly Fee for Reseller Client (Example: 3.50)
setup => Setup Fee for Reseller Client (Example: 1.99)
minute => Minute Rate for Reseller Client (Example: 0.03)
test => Set to true if testing how Orders work
- Orders can not be undone
- When testing, no Orders are made
routing, failover_busy, failover_unreachable and failover_noanswer
can receive values in the following format => header:record_id
Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none.
Examples:
account Used for routing calls to Sub Accounts
You can get all sub accounts using the getSubAccounts function
fwd Used for routing calls to Forwarding entries.
You can get the ID right after creating a Forwarding with setForwarding
or by requesting all forwardings entries with getForwardings.
vm Used for routing calls to a Voicemail.
You can get all voicemails and their IDs using the getVoicemails function
sys System Options:
hangup = Hangup the Call
busy = Busy tone
noservice = System Recording: Number not in service
disconnected = System Recording: Number has been disconnected
dtmf = DTMF Test
echo = ECHO Test
none Used to route calls to no action
Examples:
'account:100001_VoIP'
'fwd:1026'
'vm:101'
'none:'
'sys:echo'
|
| Output |
Array
(
[status] => success
)
|
| orderTollFree | |
| Parameters |
did => [Required] DID to be Ordered (Example: 8772223333)
routing => [Required] Main Routing for the DID
failover_busy => Busy Routing for the DID
failover_unreachable => Unreachable Routing for the DID
failover_noanswer => NoAnswer Routing for the DID
voicemail => Voicemail for the DID (Example: 101)
pop => [Required] Point of Presence for the DID (Example: 5)
dialtime => [Required] Dial Time Out for the DID (Example: 60 -> in seconds)
cnam => [Required] CNAM for the DID (Boolean: 1/0)
callerid_prefix => Caller ID Prefix for the DID
note => Note for the DID
account => Reseller Sub Account (Example: '100001_VoIP')
monthly => Montly Fee for Reseller Client (Example: 3.50)
setup => Setup Fee for Reseller Client (Example: 1.99)
minute => Minute Rate for Reseller Client (Example: 0.03)
test => Set to true if testing how Orders work
- Orders can not be undone
- When testing, no Orders are made
routing, failover_busy, failover_unreachable and failover_noanswer
can receive values in the following format => header:record_id
Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none.
Examples:
account Used for routing calls to Sub Accounts
You can get all sub accounts using the getSubAccounts function
fwd Used for routing calls to Forwarding entries.
You can get the ID right after creating a Forwarding with setForwarding
or by requesting all forwardings entries with getForwardings.
vm Used for routing calls to a Voicemail.
You can get all voicemails and their IDs using the getVoicemails function
sys System Options:
hangup = Hangup the Call
busy = Busy tone
noservice = System Recording: Number not in service
disconnected = System Recording: Number has been disconnected
dtmf = DTMF Test
echo = ECHO Test
none Used to route calls to no action
Examples:
'account:100001_VoIP'
'fwd:1026'
'vm:101'
'none:'
'sys:echo'
|
| Output |
Array
(
[status] => success
)
|
| orderVanity | |
| Parameters |
did => [Required] DID to be Ordered (Example: 8772223333)
routing => [Required] Main Routing for the DID
failover_busy => Busy Routing for the DID
failover_unreachable => Unreachable Routing for the DID
failover_noanswer => NoAnswer Routing for the DID
voicemail => Voicemail for the DID (Example: 101)
pop => [Required] Point of Presence for the DID (Example: 5)
dialtime => [Required] Dial Time Out for the DID (Example: 60 -> in seconds)
cnam => [Required] CNAM for the DID (Boolean: 1/0)
callerid_prefix => Caller ID Prefix for the DID
note => Note for the DID
carrier => [Required] Carrier for the DID (Values from getCarriers)
account => Reseller Sub Account (Example: '100001_VoIP')
monthly => Montly Fee for Reseller Client (Example: 3.50)
setup => Setup Fee for Reseller Client (Example: 1.99)
minute => Minute Rate for Reseller Client (Example: 0.03)
test => Set to true if testing how Orders work
- Orders can not be undone
- When testing, no Orders are made
routing, failover_busy, failover_unreachable and failover_noanswer
can receive values in the following format => header:record_id
Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none.
Examples:
account Used for routing calls to Sub Accounts
You can get all sub accounts using the getSubAccounts function
fwd Used for routing calls to Forwarding entries.
You can get the ID right after creating a Forwarding with setForwarding
or by requesting all forwardings entries with getForwardings.
vm Used for routing calls to a Voicemail.
You can get all voicemails and their IDs using the getVoicemails function
sys System Options:
hangup = Hangup the Call
busy = Busy tone
noservice = System Recording: Number not in service
disconnected = System Recording: Number has been disconnected
dtmf = DTMF Test
echo = ECHO Test
none Used to route calls to no action
Examples:
'account:100001_VoIP'
'fwd:1026'
'vm:101'
'none:'
'sys:echo'
|
| Output |
Array
(
[status] => success
)
|
| searchDIDsCAN | |
| Parameters |
province => Canadian Province (Values from getProvinces)
type => [Required] Type of search (Values: 'starts', 'contains', 'ends')
query => [Required] Query for searching (Examples: 'JOHN', '555', '123ABC')
|
| Output |
Array
(
[status] => success
[dids] => Array
(
[0] => Array
(
[did] => 4502381568
[ratecenter] => Chomedey
[province] => QC
[province_description] => QUEBEC
[perminute_monthly] => 0.99
[perminute_minute] => 0.0100
[perminute_setup] => 0.50
[flat_monthly] => 4.95
[flat_minute] => 0.00
[flat_setup] => 1.00
)
)
)
|
| searchDIDsUSA | |
| Parameters |
state => United States State (Values from getStates)
type => [Required] Type of search (Values: 'starts', 'contains', 'ends')
query => [Required] Query for searching (Examples: 'JOHN', '555', '123ABC')
|
| Output |
Array
(
[status] => success
[dids] => Array
(
[0] => Array
(
[did] => 7863643023
[ratecenter] => MIAMI
[state] => FL
[state_description] => FLORIDA
[perminute_monthly] => 0.99
[perminute_minute] => 0.01
[perminute_setup] => 0.50
[flat_monthly] => 4.95
[flat_minute] => 0.00
[flat_setup] => 1.00
)
)
)
|
| searchTollFreeCanUS | |
| Parameters |
type => Type of search (Values: 'starts', 'contains', 'ends')
query => Query for searching (Examples: 'JOHN', '555', '123ABC')
|
| Output |
Array
(
[status] => success
[dids] => Array
(
[0] => Array
(
[did] => 8774530644
[monthly] => 1.49
[minute] => 0.0320
[setup] => 0.00
)
)
)
|
| searchTollFreeUSA | |
| Parameters |
type => Type of search (Values: 'starts', 'contains', 'ends')
query => Query for searching (Examples: 'JOHN', '555', '123ABC')
|
| Output |
Array
(
[status] => success
[dids] => Array
(
[0] => Array
(
[did] => 8888355579
[monthly] => 0.99
[minute_usa] => 0.019
[minute_canada] => 0.08
[minute_puertorico] => 0.095
[minute_alaska] => 0.17
[setup] => 0
)
)
)
Note: Canada, Puerto Rico and Alaska are Unlocked on Request
|
| searchVanity | |
| Parameters |
type => [Required] Type of Vanity Number
Values: '8**', '800', '855', '866', '877', '888'
query => [Required] Query for searching : 7 Chars
Examples: '***JHON', '**555**', '**HELLO'
|
| Output |
Array
(
[status] => success
[dids] => Array
(
[0] => Array
(
[did] => 8776605646
[monthly_american] => 0.99
[monthly_canadian] => 1.49
[minute_american_usa] => 0.019
[minute_american_canada] => 0.08
[minute_canadian] => 0.032
[setup_american] => 15
[setup_canadian] => 30
)
[1] => Array
(
[did] => 8776645646
[monthly_american] => 0.99
[monthly_canadian] => 1.49
[minute_american_usa] => 0.019
[minute_american_canada] => 0.08
[minute_canadian] => 0.032
[setup_american] => 15
[setup_canadian] => 30
)
)
)
|
| sendSMS | |
| Parameters |
did => [Required] DID Numbers which is sending the message (Example: 5551234567)
dst => [Required] Destination Number (Example: 5551234568)
message => [Required] Message to be sent (Example: 'hello John Smith' max chars: 160)
|
| Output |
Array
(
[status] => success
[sms] => 23434
)
|
| setCallback | |
| Parameters |
callback => ID for a specific Callback
(Example: 2359 / Leave empty to create a new one)
description => [Required] Description for the Callback
number => [Required] Number that will be called back
delay_before => [Required] Delay befor calling back
response_timeout => [Required] Time before hanging up for incomplete input
digit_timeout => [Required] Time between digits input
callerid_number => Caller ID Override for the callback
|
| Output |
Array
(
[status] => success
[callback] => 2359
)
|
| setCallerIDFiltering | |
| Parameters |
filter => ID for a specific Caller ID Filtering
(Example: 18915 / Leave empty to create a new one)
callerid => [Required] Caller ID that triggers the Filter
(i = Non USA, 0 = Anonymous, NPANXXXXXX)
did => [Required] DIDs affected by the filter (all, NPANXXXXXX)
routing => [Required] Route the call follows when filter is triggered
failover_unreachable => Route the call follows when unreachable
failover_busy => Route the call follows when busy
failover_noanswer => Route the call follows when noanswer
note => Note for the Caller ID Filtering
|
| Output |
Array
(
[status] => success
[filtering] => 18915
)
|
| setDIDBillingType | |
| Parameters |
did => [Required] DID affected by the new billing plan
billing_type => [Required] Billing type for the DID (1 = Per Minute, 2 = Flat)
|
| Output |
Array
(
[status] => success
)
|
| setDIDInfo | |
| Parameters |
did => [Required] DID to be Updated (Example: 5551234567)
routing => [Required] Main Routing for the DID
failover_busy => Busy Routing for the DID
failover_unreachable => Unreachable Routing for the DID
failover_noanswer => NoAnswer Routing for the DID
voicemail => Voicemail for the DID
pop => [Required] Point of Presence for the DID
("server_pop" values from getServersInfo. Example: 3)
dialtime => [Required] Dial Time Out for the DID (Example: 60 -> in seconds)
cnam => [Required] CNAM for the DID (Boolean: 1/0)
callerid_prefix => Caller ID Prefix for the DID
note => Note for the DID
billing_type => [Required] Billing type for the DID (1 = Per Minute, 2 = Flat)
routing, failover_busy, failover_unreachable and failover_noanswer
can receive values in the following format => header:record_id
Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none.
Examples:
account Used for routing calls to Sub Accounts
You can get all sub accounts using the getSubAccounts function
fwd Used for routing calls to Forwarding entries.
You can get the ID right after creating a Forwarding with setForwarding
or by requesting all forwardings entries with getForwardings.
vm Used for routing calls to a Voicemail.
You can get all voicemails and their IDs using the getVoicemails function
sys System Options:
hangup = Hangup the Call
busy = Busy tone
noservice = System Recording: Number not in service
disconnected = System Recording: Number has been disconnected
dtmf = DTMF Test
echo = ECHO Test
none Used to route calls to no action
Examples:
'account:100001_VoIP'
'fwd:1026'
'vm:101'
'none:'
'sys:echo'
|
| Output |
Array
(
[status] => success
)
|
| setDIDPOP | |
| Parameters |
did => [Required] DID to be Updated (Example: 5551234567)
pop => [Required] Point of Presence for the DID
("server_pop" values from getServersInfo. Example: 3)
|
| Output |
Array
(
[status] => success
)
|
| setDIDRouting | |
| Parameters |
did => [Required] DID to be Updated (Example: 5551234567)
routing => [Required] Main Routing for the DID
routing can receive values in the following format => header:record_id
Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none.
Examples:
account Used for routing calls to Sub Accounts
You can get all sub accounts using the getSubAccounts function
fwd Used for routing calls to Forwarding entries.
You can get the ID right after creating a Forwarding with setForwarding
or by requesting all forwardings entries with getForwardings.
vm Used for routing calls to a Voicemail.
You can get all voicemails and their IDs using the getVoicemails function
Examples:
'account:100001_VoIP'
'fwd:1026'
'vm:101'
|
| Output |
Array
(
[status] => success
)
|
| setDIDVoicemail | |
| Parameters |
did => [Required] DID to be Updated (Example: 5551234567)
voicemail => Mailbox for the DID
|
| Output |
Array
(
[status] => success
)
|
| setDISA | |
| Parameters |
disa => ID for a specific DISA
(Example: 2114 / Leave empty to create a new one)
name => [Required] Name for the DISA
pin => [Required] Password for the DISA
digit_timeout => [Required] Time between digits
callerid_override => Caller ID Override for the DISA
|
| Output |
Array
(
[status] => success
[disa] => 2114
)
|
| setForwarding | |
| Parameters |
forwarding => ID for a specific Forwarding
(Example: 19183 / Leave empty to create a new one)
phone_number => [Required] Phone Number for the Forwarding
callerid_override => Caller ID Override for the Forwarding
description => Description for the Forwarding
dtmf_digits => Send DTMF digits when call is answered
pause => Pause (seconds) when call is answered before sending digits
(Example: 1.5 / Values: 0 to 10 in increments of 0.5)
|
| Output |
Array
(
[status] => success
[forwarding] => 19183
)
|
| setIVR | |
| Parameters |
ivr => ID for a specific IVR
(Example: 4636 / Leave empty to create a new one)
name => [Required] Name for the IVR
recording => [Required] Recording for the IVR (values from getRecordings)
timeout => [Required] Maximum time for type in a choice after recording
language => [Required] Language for the IVR (values from getLanguages)
voicemailsetup => [Required] Voicemail Setup for the IVR (values from getVoicemailSetups)
choices => [Required] Choices for the IVR (Example: '1=sip:5096 ; 2=fwd:20222')
|
| Output |
Array
(
[status] => success
[ivr] => 4636
)
|
| setPhonebook | |
| Parameters |
phonebook => ID for a specific Phonebook entry
(Example: 32207 / Leave empty to create a new one)
speed_dial => Speed Dial for the Phonebook entry
name => [Required] Name for the Phonebook Entry
number => [Required] Number or SIP for the Phonebook entry (Example: 'sip:2563' or '5552223333')
callerid => Caller ID Override when dialing via Speed Dial
|
| Output |
Array
(
[status] => success
[phonebook] => 32207
)
|
| setRecording | |
| Parameters |
recording => ID for a specific Phonebook entry
(Example: 33221 / Leave empty to create a new one)
file => [Required] Base64 encoded file
(Provide Recording ID and file if you want update the file only)
name => [Required] Name for the Recording Entry (Example: 'recording1')
(Provide Recording ID and name if you want update the name only)
(Provide Recording ID, file and name if you want update both parameters at the same time)
|
| Output |
Array
(
[status] => success
[recording] => 33221
)
|
| setQueue | |
| Parameters |
queue => ID for a specific Queue entry
(Example: 32208 / Leave empty to create a new one)
queue_name => [Required] Queue entry name
queue_number => [Required] Queue entry number
queue_language => [Required] Language Code (Values from getLanguages)
queue_password => Queue Password
callerid_prefix => Caller ID Prefix for queue
join_announcement => Recording Code (Values from getRecordings or 'none')
priority_weight => [Required] weight/priority of queue (Values 1 to 60)
agent_announcement => Recording Code (Values from getRecordings or 'none')
report_hold_time_agent => [Required] Report hold time to agent
(Values from getReportEstimatedHoldTime)
member_delay => Member delay when the agent is connected to the caller
(Values 1 to 15 in seconds or 'none')
maximum_wait_time => Ammount of time a caller can wait in queue
(Values in seconds: multiples of 30, max value: 1200
or 'unlimited')
maximum_callers => Maximum callers (Values: 1 to 60 or 'unlimited')
join_when_empty => [Required] How caller join to the queue
(Values from getJoinWhenEmptyTypes)
Examples:
yes Callers can join a queue with no members or
only unavailable members
no Callers cannot join a queue with no members
strict Callers cannot join a queue with no members
or only unavailable members
leave_when_empty => [Required] How caller leave the queue (Values 'yes'/'no'/'strict')
Examples:
yes Callers are sent to failover when
there are no members
no Callers will remain in the queue even
if there are no members
strict Callers are sent to failover if there are
members but none of them is available.
ring_strategy => [Required] Ring strategy (Values from getRingStrategies)
ring_inuse => [Required] If you want the queue to avoid sending calls to members
(Values 'yes'/'no')
agent_ring_timeout => Number of seconds to ring an agent (Values 5 to 60)
retry_timer => How long do we wait before trying all the members again
(Values 5 to 60 seconds or 'none'= No Delay)
wrapup_time => After a successful call, the number of seconds
to wait before sending a free agent another call
(Values 1 to 60 seconds or 'none'= No Delay)
voice_announcement => Code for Recording (Values from getRecordings or 'none')
frequency_announcement => Periodic interval to play voice announce recording
(Values in seconds: multiples of 15, max value: 1200
or 'none' = No announcement)
announce_position_frecuency => How often to make any periodic announcement
(Values in seconds: multiples of 15, max value: 1200
or 'none' = No announcement)
announce_round_seconds => Announce seconds
(Values in seconds: 1 to 60 or 'none' = Do not announce)
if_announce_position_enabled_report_estimated_hold_time =>
Include estimated hold time in position announcements
(Values 'yes'/'no'/'once')
thankyou_for_your_patience => Yes to say "Thank you for your patience"
immediatly after announcing Queue
Position and Estimated hold time left
(Values 'yes'/'no')
music_on_hold => Music on Hold Code (Values from getMusicOnHold)
fail_over_routing_timeout => Failover routing to Maximum wait time reached
fail_over_routing_full => Failover routing to Maximum callers reached
fail_over_routing_join_empty=> A call was sent to the queue but the queue had no members
(Only works when Join when Empty is set to no)
fail_over_routing_leave_empty=> The last agent was removed form the queue before alls
calls were handled
(Only works when Leave when Empty is set to yes)
fail_over_routing_join_unavail=> Same as routingjoinempty, except that there were still
queue members, but all were status unavailable
fail_over_routing_leave_unavail=> Same as routingleaveempty, except that there were still
queue members, but all were status unavailable
routings can receive values in the following format => header:record_id
Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none.
Examples:
account Used for routing calls to Sub Accounts
You can get all sub accounts using the getSubAccounts function
fwd Used for routing calls to Forwarding entries.
You can get the ID right after creating a Forwarding with setForwarding
or by requesting all forwardings entries with getForwardings.
vm Used for routing calls to a Voicemail.
You can get all voicemails and their IDs using the getVoicemails function
Examples:
'account:100001_VoIP'
'fwd:1026'
'vm:101'
|
| Output |
Array
(
[status] => success
[queue] => 32208
)
|
| setRingGroup | |
| Parameters |
ring_group => ID for a specific Ring Group
(Example: 4768 / Leave empty to create a new one)
name => [Required] Name for the Ring Group
members => [Required] Members for the Ring Group (Example: 'account:100001;fwd:16006')
voicemail => [Required] Voicemail for the Ring Group (Values from getVoicemails)
caller_announcement => Recording Code (Values from getRecordings)
music_on_hold => Music on Hold Code (Values from getMusicOnHold)
language => Code for Language (Values from getLanguages)
"members" can receive the following routing headers:
account Used to route the call to an Account or a Sub Account
fwd Used to route the call to a Forwarding entry
sip Used to route the call to a SIP URI
Each member can a specific ring time and press1 values, you can add those to the routing header as follow:
Example: 'account:100001,25,0;fwd:16006,10,1'
25 = Default ring time value (Values from 1 to 60 sec)
0 = Default press1 value (Values allowed 0 and 1)
|
| Output |
Array
(
[status] => success
[ring_group] => 4768
)
|
| setSIPURI | |
| Parameters |
sipuri => ID for a specific SIP URI
(Example: 6199 / Leave empty to create a new one)
uri => [Required] SIP URI (Example: '5552223333@sip.voip.ms')
description => Description for the SIP URI
|
| setSMS | |
| Parameters |
did => [Required] DID to be Updated (Example: 5551234567)
enable => [Required] Enable/Disable the DID to receive SMS Messages (Values:1=Enable / 0=Disable)
email_enabled => If Enable, SMS Messages received by your DID will be sent to the email address
provided (Values:1=Enable / 0=Disable)
email_address => SMS Messages received by your DID will be sent to the email address provided
sms_forward_enable=> If Enable, SMS Messages received by your DID will be forwarded to the phone
number provided (Values:1=Enable / 0=Disable)
sms_forward => SMS Messages received by your DID will be forwarded to the phone number
provided (Example: 5551234567)
url_callback_enable=> If Enable, SMS Messages received by your DID will be send a GET request to the
URL callback provided (Values:1=Enable / 0=Disable)
url_callback => SMS Messages received by your DID will be send a GET request to the URL
callback provided
Available Variables for your URL
{FROM} The phone number that sent you the message.
{TO} The DID number that received the message.
{MESSAGE} The content of the message.
Example:
http://mysite.com/sms.php?to={TO}&from={FROM}&message={MESSAGE}
url_callback_retry => Enable URL callback Retry
(Values:1=Enable / 0=Disable)
we will be expecting an "ok" output (without quotes) from your URL callback
page as an indicator that you have received the message correctly.
If we don't receive the "ok" letters (wihtout quotes) from your callback
page, we will keep sending you the same message every 30 minutes.
|
| Output |
Array
(
[status] => success
[sipuri] => 6199
)
|
| setStaticMember | |
| Parameters |
member => ID for a specific Member
(Example: 619 / Leave empty to create a new one)
queue => [Required] ID for a specific Queue
member_name => [Required] Member Description
account => Static Member Routing to receive calls
- You can get all sub accounts using the getSubAccounts function
priority => [Required] Values for get calls first (Example: 0)
|
| Output |
Array
(
[status] => success
[member] => 619
)
|
| setTimeCondition | |
| Parameters |
timecondition => ID for a specific Time Condition
(Example: 1830 / Leave empty to create a new one)
name => [Required] Name for the Time Condition
routing_match => [Required] Routing for the Call when condition matches
routing_nomatch => [Required] Routing for the Call when condition does not matche
starthour => [Required] All the Start Hour Conditions (Example: '8;8')
startminute => [Required] All the Start Minute Conditions (Example: '0;0')
endhour => [Required] All the End Hour Conditions (Example: '16;12')
endminute => [Required] All the End Minute Conditions (Example: '0;0')
weekdaystart => [Required] All the Week Day Start Conditions (Example: 'mon;sat')
weekdayend => [Required] All the Week Day End Conditions (Example: 'fri;sat')
|
| Output |
Array
(
[status] => success
[timecondition] => 1830
)
|
| unconnectDID | |
| Parameters |
did => [Required] DID to be Unconnected from Reseller Sub Account(Example: 5551234567) |
| Output |
Array
(
[status] => success
)
|
Dev License: This installation of WHMCS is running under a Development License and is not authorized to be used for production use. Please report any cases of abuse to abuse@whmcs.com
API DID Functions (continued) Print
- 0
Was this answer helpful?
Related Articles
API Function List
FUNCTIONS LIST
VoIP.ms API has over 100 functions to help you integrate our services into your...
API Function Status & Error Codes
FUNCTION STATUS AND ERROR CODE
All the API functions return a Status value after execution. -...
API General Functions
GENERAL FUNCTIONS
The following table explains the additional parameters needed by the General...
API Account Functions
ACCOUNTS FUNCTIONS
The following table explains the additional parameters needed by the...
API CDR Functions
CDR FUNCTIONS
The following table explains the additional parameters needed by the CDR...
Powered by WHMCompleteSolution
