DID FUNCTIONS
The following table explains the additional parameters needed by the DID Functions and provides an example of their output when status is 'success'.
| backOrderDIDUSA | |
| Parameters |
quantity => [Required] Number of DIDs to be Ordered (Example: 3)
state => [Required] USA State (values from getStates)
ratecenter => [Required] USA Ratecenter (Values from getRateCentersUSA)
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
billing_type => [Required] Billing type for the DID (1 = Per Minute, 2 = Flat)
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
)
|
| backOrderDIDCAN | |
| Parameters |
quantity => [Required] Number of DIDs to be Ordered (Example: 3)
province => [Required] Canadian Province (values from getProvinces)
ratecenter => [Required] USA Ratecenter (Values from getRateCentersUSA)
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
billing_type => [Required] Billing type for the DID (1 = Per Minute, 2 = Flat)
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
)
|
| CancelDID | |
| Parameters |
did => [Required] DID to be canceled and deleted (Example: 5551234567)
cancelcomment => Comment for DID cancellation
portout => Set to true if the DID is being ported out
test => Set to true if testing how cancellation works
- Cancellation can not be undone
- When testing, no changes are made
|
| Output |
Array
(
[status] => success
)
|
| connectDID | |
| Parameters |
did => [Required] DID to be Connected to Reseler Sub Account (Example: 5551234567)
account => [Required] Reseller Sub Account (Example: '100001_VoIP')
monthly => [Required] Montly Fee for Reseller Client (Example: 3.50)
setup => [Required] Setup Fee for Reseller Client (Example: 1.99)
minute => [Required] Minute Rate for Reseller Client (Example: 0.03)
|
| Output |
Array
(
[status] => success
)
|
| delCallback | |
| Parameters |
callback => [Required] ID for a specific Callback (Example: 19183) |
| Output |
Array
(
[status] => success
)
|
| delCallerIDFiltering | |
| Parameters |
filtering => [Required] ID for a specific CallerID Filtering (Example: 19183) |
| Output |
Array
(
[status] => success
)
|
| delClient | |
| Parameters |
client => [Required] ID for a specific Reseller Client (Example: 1998) |
| Output |
Array
(
[status] => success
)
|
| delDISA | |
| Parameters |
disa => [Required] ID for a specific DISA (Example: 19183) |
| Output |
Array
(
[status] => success
)
|
| deleteSMS | |
| Parameters |
id => [Required] ID for a specific SMS (Example: 1918) |
| Output |
Array
(
[status] => success
)
|
| delForwarding | |
| Parameters |
forwarding => ID for a specific Forwarding (Example: 19183) |
| Output |
Array
(
[status] => success
)
|
| delIVR | |
| Parameters |
ivr => [Required] ID for a specific IVR (Example: 19183) |
| Output |
Array
(
[status] => success
)
|
| delPhonebook | |
| Parameters |
phonebook => [Required] ID for a specific Phonebook (Example: 19183) |
| Output |
Array
(
[status] => success
)
|
| delQueue | |
| Parameters |
queue => [Required] ID for a specific Queue (Example: 13183) |
| Output |
Array
(
[status] => success
)
|
| delRecording | |
| Parameters |
recording => [Required] ID for a specific Recording (Example: 19183) |
| Output |
Array
(
[status] => success
)
|
| delRingGroup | |
| Parameters |
ringgroup => [Required] ID for a specific Ring Group (Example: 19183) |
| Output |
Array
(
[status] => success
)
|
| delSIPURI | |
| Parameters |
sipuri => [Required] ID for a specific SIP URI (Example: 19183) |
| Output |
Array
(
[status] => success
)
|
| delStaticMember | |
| Parameters |
member => [Required] ID for a specific Member Queue (Example: 1918)
queue => [Required] ID for a specific Queue (Example: 27183)
|
| Output |
Array
(
[status] => success
)
|
| delTimeCondition | |
| Parameters |
timecondition => [Required] ID for a specific Time Condition (Example: 19183) |
| Output |
Array
(
[status] => success
)
|
| getCallbacks | |
| Parameters |
callback => ID for a specific Callback (Example: 2359) |
| Output |
Array
(
[status] => success
[callbacks] => Array
(
[0] => Array
(
[callback] => 2359
[description] => John Smith
[number] => 5551234567
[delay_before] => 5
[response_timeout] => 10
[digit_timeout] => 5
[callerid_number] => 5552223333
)
)
)
|
| getCallerIDFiltering | |
| Parameters |
filtering => ID for a specific CallerID Filtering (Example: 18915) |
| Output |
Array
(
[status] => success
[filtering] => Array
(
[0] => Array
(
[filtering] => 18915
[callerid] => 5551234567
[did] => 5552223333
[routing] => cb:2359
[failover_unreachable] => none:
[failover_busy] => none:
[failover_noanswer] => none:
[note] => Callback Filtering
)
)
)
|
| getDIDCountries | |
| Parameters |
country_id => ID for a specific country (Example: 205)
type => [Required] Type of International DID (Values from getInternationalTypes)
|
| Output |
Array
(
[status] => success
[countries] => Array
(
[0] => Array
(
[value] => 205
[description] => SWEDEN (+46)
)
)
)
|
| getCarriers | |
| Parameters |
carrier => Code for a specific Carrier (Example: 2) |
| Output |
Array
(
[status] => success
[carriers] => Array
(
[0] => Array
(
[value] => 2
[description] => American Carrier, American and Canadian Callers allowed
)
)
)
|
| getDIDsCAN | |
| Parameters |
province => [Required] Canadian Province (Values from getProvinces)
ratecenter => Canadian Ratecenter (Values from getRateCentersCAN)
|
| Output |
Array
(
[status] => success
[dids] => Array
(
[0] => Array
(
[did] => 2264836080
[ratecenter] => Stoney Point
[province] => ON
[province_description] => ONTARIO
[perminute_monthly] => 0.99
[perminute_minute] => 0.0100
[perminute_setup] => 0.50
[flat_monthly] => 4.95
[flat_minute] => 0.00
[flat_setup] => 1.00
[sms] => 1
)
[2] => Array
(
[did] => 2264836086
[ratecenter] => Stoney Point
[province] => ON
[province_description] => ONTARIO
[perminute_monthly] => 0.99
[perminute_minute] => 0.0100
[perminute_setup] => 0.50
[flat_monthly] => 4.95
[flat_minute] => 0.00
[flat_setup] => 1.00
[sms] => 1
)
)
)
|
| getDIDsInfo | |
| Parameters |
client => Parameter could have the following values:
* Empty Value [Not Required]
* Specific Reseller Client ID (Example: 561115)
* Specific Sub Account (Example: '100001_VoIP')
did => DID from Client or Sub Account (Example: 5551234567)
|
| Output |
Array
(
[status] => success
[dids] => Array
(
[0] => Array
(
[did] => 5551234567
[description] => MIAMI, FL
[routing] => account:100001_VoIP
[failover_busy] => none:
[failover_unreachable] => fwd:1521
[failover_noanswer] => none:
[voicemail] => 1001
[pop] => 16
[dialtime] => 60
[cnam] => 1
[e911] => 0
[callerid_prefix] => MIA [555]
[note] => MIA [555]
[billing_type] => 2
[next_billing] => 2014-08-30
[order_date] => 2014-07-30 15:09:04
[reseller_account] => 100001_VoIPReseller
[reseller_monthly] => 0.00000000
[reseller_minute] => 0.01000000
[reseller_setup] => 0.00000000
[sms_available] => 1
[sms_enabled] => 1
[sms_email] => john.doe@example.com
[sms_email_enabled] => 1
[sms_forward] => 2264836086
[sms_forward_enabled] => 1
[sms_url_callback] => http://myurl.com
[sms_url_callback_enabled] => 1
[sms_url_callback_retry] => 1
)
)
)
|
| getDIDsInternationalGeographic | |
| Parameters |
country_id => [Required] ID for a specific Country (Values from getDIDCountries) |
| Output |
Array
(
[status] => success
[locations] => Array
(
[0] => Array
(
[location_id] => 65
[location_name] => HELSINKI
[country] => FINLAND
[area_code] => 9
[stock] => 2
[monthly] => 5.00
[setup] => 0.00
[minute] => 0.00
[channels] => 2
)
[1] => Array
(
[location_id] => 9468
[location_name] => KESKI-SUOMI
[country] => FINLAND
[area_code] => 14
[stock] => 93
[monthly] => 5.00
[setup] => 0.00
[minute] => 0.00
[channels] => 2
)
)
)
|
| getDIDsInternationalNational | |
| Parameters |
country_id => [Required] ID for a specific Country (Values from getDIDCountries) |
| Output |
Array
(
[status] => success
[locations] => Array
(
[0] => Array
(
[location_id] => 5644
[location_name] => NATIONAL
[country] => SPAIN
[area_code] => 901
[stock] => 4
[monthly] => 11.50
[setup] => 11
[minute] => 0
)
[1] => Array
(
[location_id] => 6847
[location_name] => NATIONAL
[country] => SPAIN
[area_code] => 902
[stock] => 135
[monthly] => 11.50
[setup] => 11
[minute] => 0
)
)
)
|
| getDIDsInternationalTollFree | |
| Parameters |
country_id => [Required] ID for a specific Country (Values from getDIDCountries) |
| Output |
Array
(
[status] => success
[locations] => Array
(
[0] => Array
(
[location_id] => 6422
[location_name] => TOLLFREE
[country] => ARGENTINA
[area_code] => 800
[stock] => 19
[monthly] => 37.50
[setup] => 72.50
[minute] => 0.20
)
[1] => Array
(
[location_id] => 6424
[location_name] => TOLLFREE
[country] => ARGENTINA
[area_code] => 822
[stock] => 15
[monthly] => 37.50
[setup] => 72.50
[minute] => 0.20
)
)
)
|
| getDIDsUSA | |
| Parameters |
state => [Required] United States State (Values from getStates)
ratecenter => United States Ratecenter (Values from getRateCentersUSA)
|
| Output |
Array
(
[status] => success
[dids] => Array
(
[0] => Array
(
[did] => 7862285619
[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
[sms] => 1
)
[1] => Array
(
[did] => 7862285871
[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
[sms] => 1
)
)
)
|
| getDISAs | |
| Parameters |
disa => ID for a specific DISA (Example: 2114) |
| Output |
Array
(
[status] => success
[disa] => Array
(
[0] => Array
(
[disa] => 2114
[name] => Jonhs DISA
[pin] => 1234
[digit_timeout] => 10
[callerid_override] => 5552223333
)
)
)
|
| getForwardings | |
| Parameters |
forwarding => ID for a specific Forwarding (Example: 18635) |
| Output |
Array
(
[status] => success
[forwardings] => Array
(
[0] => Array
(
[forwarding] => 18635
[phone_number] => 5553334444
[callerid_override] => 5551234567
[description] => RESELLER| 5553334444
[dtmf_digits] => 123
[pause] => 1.5
)
)
)
|
| getInternationalTypes | |
| Parameters |
type => Code for a specific International Type (Example: 'NATIONAL') |
| Output |
Array
(
[status] => success
[types] => Array
(
[0] => Array
(
[value] => NATIONAL
[description] => National Numbers (Non-Geographical)
)
)
)
|
| getIVRs | |
| Parameters |
ivr => ID for a specific IVR (Example: 4636) |
| Output |
Array
(
[status] => success
[ivrs] => Array
(
[0] => Array
(
[ivr] => 4636
[name] => Johns IVR
[recording] => 7696
[timeout] => 5
[language] => fr
[voicemailsetup] => 1
[choices] => 1=sip:5096;2=fwd:20222
)
)
)
|
| getJoinWhenEmptyTypes | |
| Parameters |
type => Code for a specific 'JoinWhenEmpty' Type (Example: 'yes') |
| Output |
Array
(
[status] => success
[types] => Array
(
[0] => Array
(
[value] => yes
[description] => Yes
)
)
)
|
| getPhonebook | |
| Parameters |
phonebook => ID for a specific Phonebook entry (Example: 32207)
name => Name to be searched in database (Example: 'jane')
|
| Output |
Array
(
[status] => success
[phonebooks] => Array
(
[0] => Array
(
[phonebook] => 32207
[speed_dial] => *7501
[name] => Jane Smith
[number] => 5553334444
[callerid] => 5552223333
[note] => Janes Mobile
)
)
)
|
| getPortability | |
| Parameters |
DID => [Required] DID Number to be ported into our network (Example: 5552341234) |
| Output |
Array
(
[status] => success
[portable] => yes
[plans] => Array
(
[0] => Array
(
[title] => Per Minute Plan
[pricePerMonth] => 0.99
[pricePerMin] => 0.01
)
[1] => Array
(
[title] => Monthly Flat Rate Plan
[pricePerMonth] => 4.95
[pricePerMin] => 0.00
)
)
)
|
| getRecordings | |
| Parameters |
recording => ID for a specific Recording (Example: 7567) |
| Output |
Array
(
[status] => success
[recordings] => Array
(
[0] => Array
(
[value] => 7567
[description] => IVR Recording
)
)
)
|
| getRingGroups | |
| Parameters |
ringgroup => ID for a specific Ring Group (Example: 4768) |
| Output |
Array
(
[status] => success
[ring_groups] => Array
(
[0] => Array
(
[ring_group] => 4768
[name] => Account & Mobile
[caller_announcement] => 7567
[music_on_hold] => jazz
[language] => en
[members] => account:100001;fwd:16006
[voicemail] => 101
)
)
)
|
| getRingStrategies | |
| Parameters |
strategy => ID for a specific Ring Strategy (Example: 'rrmemory') |
| Output |
Array
(
[status] => success
[strategies] => Array
(
[0] => Array
(
[value] => rrmemory
[description] => Round Robin Memory
)
)
)
|
| getSIPURIs | |
| Parameters |
sipuri => ID for a specific SIP URI (Example: 6199) |
| Output |
Array
(
[status] => success
[sipuris] => Array
(
[0] => Array
(
[sipuri] => 6199
[uri] => 5552223333@sip.voip.ms
[description] => Jonh Smith
)
)
)
|
| getSMS | |
| Parameters |
sms => ID for a specific SMS (Example: 5853)
from => Start Date for Filtering SMSs (Example: '2014-03-30')
- Default value: Today
to => End Date for Filtering SMSs (Example: '2014-03-30')
- Default value: Today
type => Filter SMSs by Type (Boolean: 1 = received / 0 = sent)
did => DID number for Filtering SMSs (Example: 5551234567)
contact => Contact number for Filtering SMSs (Example: 5551234567)
limit => Number of records to be displayed (Example: 20)
- Default value: 50
timezone=> Adjust time of SMSs according to Timezome (Numeric: -12 to 13)
|
| Output |
Array
(
[status] => success
[sms] => Array
(
[0] => Array
(
[id] => 111120
[date] => 2014-03-30 10:24:16
[type] => 0
[did] => 8574884828
[contact] => 8577884821
[message] => hello+john
)
)
)
|
| getProvinces | |
| Parameters |
No Parameter |
| Output |
Array
(
[status] => success
[provinces] => Array
(
[0] => Array
(
[province] => ON
[description] => ONTARIO
)
[1] => Array
(
[province] => QC
[description] => QUEBEC
)
[2] => Array
(
[province] => AB
[description] => ALBERTA
)
)
)
|
| getQueues | |
| Parameters |
queue => ID for a specific Queue (Example: 4764)
|
| Output |
Array
(
[status] => success
[queues] => Array
(
[0] => Array
(
[queue] => 3008
[queue_name] => call_center5
[queue_number] => 6
[queue_language] => en
[queue_password] =>
[callerid_prefix] =>
[join_announcement] => none
[priority_weight] => 1
[agent_announcement] => 0
[report_hold_time_agent] => yes
[member_delay] => 10
[music_on_hold] => jazz
[maximum_wait_time] => 60
[maximum_callers] => 10
[join_when_empty] => no
[leave_when_empty] => yes
[ring_strategy] => rrmemory
[ring_inuse] => yes
[agent_ring_timeout] => 5
[retry_timer] => 5
[wrapup_time] => 20
[voice_announcement] => 0
[frequency_announcement] => none
[announce_position_frecuency] => none
[announce_round_seconds] => none
[if_announce_position_enabled_report_estimated_hold_time] => yes
[thankyou_for_your_patience] => yes
[fail_over_routing_timeout] => fwd:19999
[fail_over_routing_full] => vm:149601
[fail_over_routing_join_empty] => fwd:15555
[fail_over_routing_leave_empty] => none:
[fail_over_routing_join_unavail] => none:
[fail_over_routing_leave_unavail] => none:
)
)
)
|
| getRateCentersCAN | |
| Parameters |
province => [Required] Canadian Province (Values from getProvinces) |
| Output |
Array
(
[status] => success
[ratecenters] => Array
(
[0] => Array
(
[ratecenter] => Calgary
[available] => yes
)
[1] => Array
(
[ratecenter] => Canmore
[available] => yes
)
[2] => Array
(
[ratecenter] => Edmonton
[available] => yes
)
)
)
|
| getRateCentersUSA | |
| Parameters |
state => [Required] United States State (Values from getStates) |
| Output |
Array
(
[status] => success
[ratecenters] => Array
(
[0] => Array
(
[ratecenter] => ALFORD
[available] => no
)
[1] => Array
(
[ratecenter] => APOPKA
[available] => yes
)
[2] => Array
(
[ratecenter] => ARCADIA
[available] => yes
)
)
)
|
| getStates | |
| Parameters |
No Parameter |
| Output |
Array
(
[status] => success
[states] => Array
(
[0] => Array
(
[state] => AL
[description] => ALABAMA
)
[1] => Array
(
[state] => AR
[description] => ARKANSAS
)
[2] => Array
(
[state] => AZ
[description] => ARIZONA
)
)
)
|
| getStaticMembers | |
| Parameters |
queue => [Required] ID for a specific Queue (Example: 4136)
member => ID for a specific Static Member (Example: 163)
- The Member must belong to the queue provided
|
| Output |
Array
(
[status] => success
[members] => Array
(
[0] => Array
(
[member] => 163
[queue_number] => 4136
[name] => as
[account] => SIP/10000_johnsmith
[priority] => 0
)
)
)
|
| getTimeConditions | |
| Parameters |
timecondition => ID for a specific Time Condition (Example: 1830) |
| Output |
Array
(
[status] => success
[timecondition] => Array
(
[0] => Array
(
[timecondition] => 1830
[name] => Johns Work
[routing_match] => account:100001
[routing_nomatch] => vm:101
[starthour] => 8;8
[startminute] => 0;0
[endhour] => 16;12
[endminute] => 0;0
[weekdaystart] => mon;sat
[weekdayend] => fri;sat
)
)
)
|
| getVoicemailSetups | |
| Parameters |
voicemailsetup => ID for a specific Voicemail Setup (Example: 2) |
| Output |
Array
(
[status] => success
[voicemailsetups] => Array
(
[0] => Array
(
[value] => 2
[description] => Account Voicemail
)
)
)
|
| getVoicemailAttachmentFormats | |
| Parameters |
email_attachment_format => ID for a specific attachment format (Example: wav49) |
| Output |
Array
(
[status] => success
[email_attachment_formats] => Array
(
[0] => Array
(
[value] => wav49
[description] => Recommended Smaller File Size
)
[1] => Array
(
[value] => wav
[description] => Uncompressed Bigger File Size
)
)
)
|
| orderDID | |
| Parameters |
did => [Required] DID to be Ordered (Example: 5552223333)
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
billing_type => [Required] Billing type for the DID (1 = Per Minute, 2 = Flat)
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
)
|
| orderDIDInternationalGeographic | |
| Parameters |
location_id => [Required] ID for a specific International Location
(Values from getDIDsInternationalGeographic)
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
)
|
| orderDIDInternationalNational | |
| Parameters |
location_id => [Required] ID for a specific International Location
(Values from getDIDsInternationalNational)
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
)
|
| orderDIDInternationalTollFree (see next page) | |
