member          => [Required]  Specific Member ID (Example: 6547)
conference      => [Required]  Specific Conference ID (Example: 234)                            

Array
(
    [status] => success
    [member] => 4234
)
                            

advanced   => True for Calls Statistics

Array
(
    [status] => success
    [balance] => Array
        (
            [current_balance] => 112.192790
            [spent_total] => 21.05321
            [calls_total] => 2788
            [time_total] => 10:17:48
            [spent_today] => 0.1205
            [calls_today] => 5
            [time_today] => 10:50
        )
)
                            

conference    => Code for a specific Conference (Example: 1599)

Array
(
    [status] => success
    [conference] => Array
        (
            [0] => Array
                (
                    [conference] => 1599
                    [name] => testing
                    [description] => testing conference
                    [max_members] => 1
                    [sound_join] => 0
                    [sound_leave] => 0
                    [sound_has_joined] => 0
                    [sound_has_left] => 0
                    [sound_kicked] => 0
                    [sound_muted] => 0
                    [sound_unmuted] => 0
                    [sound_only_person] => 0
                    [sound_only_one] => 0
                    [sound_there_are] => 0
                    [sound_other_in_party] => 0
                    [sound_place_into_conference] => 0
                    [sound_get_pin] => 0
                    [sound_invalid_pin] => 0
                    [sound_locked] => 0
                    [sound_locked_now] => 0
                    [sound_unlocked_now] => 0
                    [sound_error_menu] => 0
                    [sound_participants_muted] => 0
                    [sound_participants_unmuted] => 0
                    [language] => en
                    [members] => 30;31;32
                )
        )
)
                            

member    => Code for a specific Member profile (Example: 1599)

Array
(
    [status] => success
    [members] => Array
        (
            [0] => Array
                (
                    [member] => 1599
                    [name] => testing
                    [description] => testing description
                    [pin] => 1234
                    [announce_join_leave] => no
                    [admin] => no
                    [start_muted] => no
                    [announce_user_count] => no
                    [announce_only_user] => yes
                    [moh_when_empty] => guitar_alchemy
                    [quiet] => no
                    [announcement] => 0
                    [drop_silence] => yes
                    [talking_threshold] => 140
                    [silence_threshold] => 2500
                    [talk_detection] => yes
                    [jitter_buffer] => yes
                )
        )
)
                            

conference  => [Required] ID for a specific Conference (Example: 5356)
date_from   => Start Date for Filtering Transactions (Example: '2016-06-03')
date_to     => End Date for Filtering Transactions (Example: '2016-06-04')                            

Array
(
    [status] => success
    [recordings] => Array
        (
            [0] => Array
                (
                    [did] => 1234567890
                    [recording] => 1543338379
                    [conference] => 1234
                    [duration] => 6
                    [date] => 2018-11-27 12:06:19
                )
        )
)
                            

conference  => [Required] ID for a specific Conference (Example: 5356)
recording   => [Required] ID for a specific Conference Recording (Example: 1543338379)                            

Array
(
    [status] => success
    [recording] => Array
        (
            [0] => Array
                (
                    [recording] => 1543338379
                    [data] => UklGRqTEAQBXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YYDEA....
                )
        )
)
                            

sequence    => ID for a specific Sequence (Example: 5356)
client      => [Optional] ID for a specific Reseller Client (Example: 561115)                            

Array
(
    [status] => success
    [sequences] => Array
        (
            [0] => Array
                (
                    [id] => 1599
                    [name] => testing
                    [steps] =>  "[
                        {
                            "type": "rec",
                            "id": "1234"
                        },
                        {
                            "type": "dtmf",
                            "codes": "1234"
                        },
                        {
                            "type": "sms",
                            "from": "1234567890",
                            "to": "0987654321",
                            "msg": "This is a test."
                        }
                    ]"
                )
        )
)
                            

country    => Code for a specific Country (Example: 'CA')

Array
(
    [status] => success
    [countries] => Array
        (
            [0] => Array
                (
                    [value] => CA
                    [description] => Canada
                )
        )
)
                            

No Parameter

Array
(
    [status] => success
    [ip] => 174.132.203.114
)
                            

language   => Code for a specific Language (Example: 'en')

Array
(
    [status] => success
    [languages] => Array
        (
            [0] => Array
                (
                    [value] => en
                    [description] => English
                )
        )
)
                            

locale   => Code for a specific Locale Code (Example: 'en-US')

Array
(
    [status] => success
    [locales] => Array
        (
            [0] => Array
                (
                    [value] => ar-EG
                    [description] => Arabic (Egypt), modern standard
                )
        )
)
                            

server_pop => POP for a specific Server (Example: 1)

Array
(
    [status] => success
    [servers] => Array
        (
            [0] => Array
                (
                    [server_name] => Houston, TX
                    [server_shortname] => Houston
                    [server_hostname] => houston.voip.ms
                    [server_ip] => 209.62.1.2
                    [server_country] => USA
                    [server_pop] => 1
                    [server_recommended] => Yes
                )
        )
)
                            

date_from     => [Required] Start Date for Filtering Transactions (Example: '2016-06-03')
date_to       => [Required] End Date for Filtering Transactions (Example: '2016-06-04')                            

Array
(
    [status] => success
    [transactions] => Array
        (
            [0] => Array
                (
                    [date] => 2016-06-03 00:03:46
                    [uniqueid] => 12964421x41098i8c
                    [type] => DID8555555555
                    [description] => DID Monthly Fee: 8555555555
                    [ammount] => -0.99
                )
        )
)
                            

username               => [Required] Username for the Sub Account (Example: 'VoIP')
protocol               => [Required] Protocol used for the Sub Account (Values from getProtocols)
description            =>            Sub Account Description (Example: 'VoIP Account')
auth_type              => [Required] Authorization Type Code (Values from getAuthTypes)
password               =>            Sub Account Password (For Password Authentication)
ip                     =>            Sub Account IP (For IP Authentication)
device_type            => [Required] Device Type Code (Values from getDeviceTypes)
callerid_number        =>            Caller ID Override
canada_routing         =>            Route Code (Values from getRoutes)
lock_international     => [Required] Lock International Code (Values from getLockInternational)
allow225               =>            When Enabled, calls placed to *225 will provide the Current Balance of the VoIP.ms Account.
                                     When Disabled, calls placed to *225 will be rejected.
international_route    => [Required] Route Code (Values from getRoutes)
music_on_hold          => [Required] Music on Hold Code (Values from getMusicOnHold)
language               =>             Language for system messages, such as "Invalid Option" (Values from getLanguages)

record_calls           =>             Record Calls (Boolean: 1/0)
allowed_codecs         => [Required] List of Allowed Codecs (Values from getAllowedCodecs) Codecs separated by semicolon (Example: ulaw;g729;gsm)
dtmf_mode              => [Required] DTMF Mode Code (Values from getDTMFModes)
nat                    => [Required] NAT Mode Code (Values from getNAT)
sip_traffic            =>            Encrypted SIP Traffic (Boolean: 1/0)
max_expiry             =>            Max Expiry between 60 and 3600 (Example: 3000)
rtp_timeout            =>            RTP Time Out between 1 and 3600 (Example: 60)
rtp_hold_timeout       =>            RTP Hold Time Out between 1 and 3600 (Example: 600)
ip_restriction         =>            List of IP/Netmask to allow outgoing calls separated by commas
                                     (Example: 10.255.12.0/22,123.45.3.21/30)
enable_ip_restriction  =>            Enable IP Restriction (Boolean: 1/0)
pop_restriction        =>            List of POP Servers to allow outgoing calls separated by commas
                                     (values from getServersInfo. Example: 10,23,45)
enable_pop_restriction =>            Enable POP Restriction (Boolean: 1/0)
send_bye               =>            Send BYE on successful transfer (Boolean: 1/0)
transcribe             =>            Enable Call Transcription (Boolean: 1/0)
transcription_locale   =>            Call Transcription Locale (values from getLocales)
transcription_email    =>            Call Transcription Email
internal_extension     =>            Sub Account Internal Extension (Example: 1 -> Creates 101)
internal_voicemail     =>            Sub Account Internal Voicemail (Example: 101)
internal_dialtime      =>            Sub Account Internal Dialtime (Example: 60 -> seconds)
reseller_client        =>            Reseller Account ID (Example: 561115)
reseller_package       =>            Reseller Package (Example: 92364)
reseller_nextbilling   =>            Reseller Next Billing Date (Example: '2012-12-31')
reseller_chargesetup   =>            True if you want to charge Package Setup Fee after Save
parking_lot            =>            ID for a specific Call Parking (Example: 323)

Array
(
    [status] => success
    [id] => 99785
    [account] => 100000_VoIP
)
                            

id     => ID for a specific Sub Account (Example: 99785) 

Array
(
    [status] => success
)
                            

codec  => Code for a specific Codec (Example: 'ulaw')

Array
(
    [status] => success
    [allowed_codecs] => Array
        (
            [0] => Array
                (
                    [value] => ulaw
                    [description] => G.711U
                )
        )
)
                            

type   => Code for a specific Authorization Type (Example: 2)

Array
(
    [status] => success
    [auth_types] => Array
        (
            [0] => Array
                (
                    [value] => 2
                    [description] => Static IP Authentication
                )
        )
)
                            

device_type    => Code for a specific Device Type (Example: 1)

Array
(
    [status] => success
    [device_types] => Array
        (
            [0] => Array
                (
                    [value] => 1
                    [description] => Asterisk, IP PBX, Gateway or VoIP Switch
                )
        )
)
                            

dtmf_mode  => Code for a specific DTMF Mode (Example: 'inband')

Array
(
    [status] => success
    [dtmf_modes] => Array
        (
            [0] => Array
                (
                    [value] => inband
                    [description] => INBAND
                )
        )
)
                            

from            =>            Start Date to generate invoice. (Example: '2020-11-25')
to              =>            End Date to generate invoice. (Example: '2020-12-25')
range           =>            Predefined ranges of dates to generate invoice:

                              1 = Last Month: 1st day of previous month to last day of previous month
                              2 = Last 2 Months: 1st day of the previous 2 months to last day of previous month.
                              3 = Last 3 Months: 1st day of the previous 3 months to last day of the previous month.
                              4 = Current Month: 1st day of this month until today
                              5 = Last Week: Monday of last week to Sunday of last week.
                              6 = Current Week: Monday of this week until today.

type            =>            Type of invoice to be generated, possible values: 0 = US, 1 = CAN                            

Array
(
    [status] => success
    [pdf] => http://www.voip.ms/invoice.php?data=HASHCODE
)
                            

lock_international     => Code for a specific Lock International Mode (Example: 1)

Array
(
    [status] => success
    [lock_international] => Array
        (
            [0] => Array
                (
                    [value] => 1
                    [description] => International Calls Disabled
                )
        )
)
                            

music_on_hold  => Code for a specific Music on Hold (Example: 'jazz')

Array
(
    [status] => success
    [music_on_hold] => Array
        (
            [0] => Array
                (
                    [value] => jazz
                    [description] => Easy Listening
                    [recordings] => 100010,100011
                    [total] => 2
                    [volume] => mp3
                    [sort] => random
                    [custom] => 1
                )
        )
)
                            

name                   =>            Music on Hold Name (Values from getMusicOnHold)
description            => [Required] Music on Hold Description
volume                 =>            Music on Hold Quiet Volume (Boolean: 1/0)
sort                   =>            Selected recordings sort mode (Example: "alpha", "random")
recordings             => [Required] Selected recordings separated by commas (Values from getRecordings, example: (1234,1235,1236)
                            

Array
(
    [status] => success
)
                            

music_on_hold          => [Required] Music on Hold Name (Values from getMusicOnHold)                            

Array
(
    [status] => success
)
                            

nat    => Code for a specific NAT Option (Example: 'route')

Array
(
    [status] => success
    [nat] => Array
        (
            [0] => Array
                (
                    [value] => route
                    [description] => Route
                )
        )
)
                            

protocol   => Code for a specific Protocol (Example: 3)

Array
(
    [status] => success
    [protocols] => Array
        (
            [0] => Array
                (
                    [value] => 3
                    [description] => IAX2
                )
        )
)
                            

account    => [Required] Specific Account (Example: '100001_VoIP')

Array
(
    [status] => success
    [registered] => yes
    [rerouted] => 1
    [from_server_pop] => 65
    [registrations] => Array
        (
            [0] => Array
                (
                    [server_name] => Atlanta, GA
                    [server_shortname] => Atlanta
                    [server_hostname] => atlanta.voip.ms
                    [server_ip] => 174.34.146.162
                    [server_country] => USA
                    [server_pop] => 15
                    [register_ip] => 189.148.32.179
                    [register_port] => 59870
                    [register_next] => 2010-11-30 16:48:30
                    [register_protocol] => SIP
                    [register_transport] => UDP
                )
        )
)
                            

type   =>             Code for a specific 'ReportEstimatedHoldTime' Type (Example: 'yes')

Array
(
    [status] => success
    [types] => Array
        (
            [0] => Array
                (
                    [value] => yes
                    [description] => Yes
                )

        )

)
                            

route  => Code for a specific Route (Example: 2)

Array
(
    [status] => success
    [routes] => Array
        (
            [0] => Array
                (
                    [value] => 2
                    [description] => Premium
                )
        )
)
                            

account     => Parameter could have the following values:
               * Empty Value [Not Required]
               * Specific Sub Account (Example: '100000_VoIP')
               * Specific Reseller Client ID (Example: 561115)                            

Array
(
    [status] => success
    [accounts] => Array
        (
            [0] => Array
                (
                    [id] => 99785
                    [account] => 100000_VoIP
                    [username] => VoIP
                    [description] => My VoIP Account
                    [protocol] => 1
                    [auth_type] => 1
                    [password] => voip@house
                    [ip] =>
                    [device_type] => 2
                    [callerid_number] => 5551234567
                    [canada_routing] => 2
                    [lock_international] => 0
                    [international_route] => 1
                    [music_on_hold] => jazz
                    [language] => en
                    [allowed_codecs] => ulaw;gsm
                    [dtmf_mode] => auto
                    [nat] => yes
                    [sip_traffic] => 0
                    [max_expiry] => 3600
                    [rtp_timeout] => 60
                    [rtp_hold_timeout] => 600
                    [ip_restriction] => 187.26.33.87/25,104.255.12.0/22
                    [enable_ip_restriction] => 1
                    [pop_restriction] => 82,83,84,71,73,74,97
                    [enable_pop_restriction] => 1
                    [send_bye] => 1
                    [record_calls] => 1
                    [internal_extension] => 0
                    [internal_voicemail] => 100
                    [internal_dialtime] => 30
                    [reseller_client] => 561115
                    [reseller_package] => 92364
                    [reseller_nextbilling] => 2012-12-31
                    [transcribe] => 1
                    [transcription_locale] => en-US
                    [transcription_email] => test@example.com
                    [parking_lot]=> 323
                )
        )
)

                            

id                     => [Required] Sub Account ID (Example: 10236)
description            =>            Sub Account Description (Example: 'VoIP Account')
auth_type              => [Required] Authorization Type Code (Values from getAuthTypes)
password               =>            Sub Account Password (For Password Authentication)
ip                     =>            Sub Account IP (For IP Authentication)
device_type            => [Required] Device Type Code (Values from getDeviceTypes)
callerid_number        =>            Caller ID Override
canada_routing         =>            Route Code (Values from getRoutes)
lock_international     => [Required] Lock International Code (Values from getLockInternational)
allow225               =>            When Enabled, calls placed to *225 will provide the Current Balance of the VoIP.ms Account.
                                     When Disabled, calls placed to *225 will be rejected.
international_route    => [Required] Route Code (Values from getRoutes)
music_on_hold          => [Required] Music on Hold Code (Values from getMusicOnHold)
language               =>             Language for system messages, such as "Invalid Option" (Values from getLanguages)

record_calls           =>             Record Calls (Boolean: 1/0)
allowed_codecs         => [Required] List of Allowed Codecs (Values from getAllowedCodecs) Codecs separated by semicolon (Example: ulaw;g729;gsm)
dtmf_mode              => [Required] DTMF Mode Code (Values from getDTMFModes)
nat                    => [Required] NAT Mode Code (Values from getNAT)
sip_traffic            =>            Encrypted SIP Traffic (Boolean: 1/0)
max_expiry             =>            Max Expiry between 60 and 3600 (Example: 3000)
rtp_timeout            =>            RTP Time Out between 1 and 3600 (Example: 60)
rtp_hold_timeout       =>            RTP Hold Time Out between 1 and 3600 (Example: 600)
ip_restriction         =>            List of IP/Netmask to allow outgoing calls separated by commas
                                     (Example: 10.255.12.0/22,123.45.3.21/30)
enable_ip_restriction  =>            Enable IP Restriction (Boolean: 1/0)
pop_restriction        =>            List of POP Servers to allow outgoing calls separated by commas
                                     (values from getServersInfo. Example: 10,23,45)
enable_pop_restriction =>            Enable POP Restriction (Boolean: 1/0)
send_bye               =>            Send BYE on successful transfer (Boolean: 1/0)
internal_extension     =>            Sub Account Internal Extension (Example: 1 -> Creates 101)
internal_voicemail     =>            Sub Account Internal Voicemail (Example: 101)
internal_dialtime      =>            Sub Account Internal Dialtime (Example: 60 -> seconds)
reseller_client        =>            Reseller Account ID (Example: 561115)
reseller_package       =>            Reseller Package (Example: 92364)
reseller_nextbilling   =>            Reseller Next Billing Date (Example: '2012-12-31')
reseller_chargesetup   =>            True if you want to charge Package Setup Fee after Save
parking_lot            =>            ID for a specific Call Parking (Example: 323)
                            

Array
(
    [status] => success
)
                            

callparking   => ID for a specific Call Parking (Example: 737)

Array
(
    [status] => success
    [call_hunting] => Array
        (
            [0] => Array
                (
                    [callparking] => 13
                    [name]        => new callparking
                    [timeout]     => 60
                    [musiconhold] => away_in_the_tropics
                    [failover]    => callback
                    [language]    => en
                    [destination] => parker
                    [delay]       => 5
                    [blf_lamps]   => 10
                )

        )

)
                            

callparking => ID for a specific Call Parking (Example: 235 / Leave empty to create a new one)
name        => [Required] Name for the Call Parking
timeout     => [Required] The number of seconds a call will stay parked before it is forwarded to the Failover Destination
music       => [Required] Music on Hold Code (Values from getMusicOnHold)
failover    => [Required] Final destination where the call will be forwarded if it isn�t answered. (Values: callback, system:hangup, vm:mailbox)
language    => [Required] Language for the Call Parking (values from getLanguages)
destination => [Required] The system will make an automatic call to this destination to announce the extension of the parked call. (Values: parker, main account or sub-accounts)
delay       => [Required] The number of seconds before the Announce Destination receives an automatic call from the system to announce the extension of the parked call
blf_lamps   => [Required] You can enable BLF for your Parking Lot and select the amount of BLF Lamps that you require. (Values: 0 to 10)
                            

Array
(
    [status]      => success
    [callparking] => 235
)
                            

callparking    => [Required] ID for a specific Call Parking (Example: 323)

Array
(
    [status] => success
)
                            

account      =>  [Required]   Filter Call Recordings by Account (Values from getCallAccounts)
start        =>               Number of records shown previously, used for pages
length       =>               Number of records to show
date_from    =>  [Required]   Start Date for Filtering Call Recording (Example:'2018-11-01')
date_to      =>  [Required]   End Date for Filtering Call Recording (Example:'2018-12-01')
call_type    =>               Call Type for Filtering Call Recording (Accepted values: 'all', 'incoming' and 'outgoing')
                                

Array
(
    [status] => success
    [recordings] => Array
        (
            [0] => Array
                (
                    [callrecording] => MTA5Nzk5LTUyOTk5MjQyNjE5NC01Mjk5OTM5OTA1MjAtSU4tMTU0NDEzMTMwNg
                    [datetime] => 2018-12-06 16:21:46
                    [destination] => 999999999
                    [type] => Incoming
                    [subaccount] => 109799
                    [duration] => 00:26
                )

            [1] => Array
                (
                    [callrecording] => MTA5Nzk5LTUyOTk5MjQyNjE5NC01Mjk5OTM5OTA1MjAtSU4tMTU0NDEzMTMwNg
                    [datetime] => 2018-12-06 16:21:46
                    [destination] => 555555555
                    [type] => Outgoing
                    [subaccount] => 109799
                    [duration] => 00:26
                )
        )
)
                            

account       =>  [Required]   Main Account or Sub Account related to the call recording (Values from getCallRecordings)
callrecording =>  [Required]   Call Recording (Values from getCallRecordings)
                            

Array
(
    [status] => success
    [callrecording] => MTA5Nzk5LTUyOTk5MjQyNjE5NC01Mjk5OTM5OTA1MjAtSU4tMTU0NDEzMTMwNg
    [datetime] => 2018-12-06 16:21:46
    [destination] => 999999999
    [type] => Incoming
    [subaccount] => 109799
    [duration] => 00:26
    [base64file] => "\/+M4xAAAAAAAAAAAAEluZm8AAAAPAAABZwA BL8AAAgUHCgwPEhQXGRwfISQmKSwuMTM2ODs +
    QENFSEpNT1JUV1lcXmFkZmlrbnBzdnh7fYCDhYiKjZCSlZeanJ+hpKapq66ws7W4u73AwsXIys3P0tTX2tzf4eTn6 e
    zu8fP2+Pv9AAAAOUxBTUUzLjEwMAEoAAAAAC47AAAUGCQDoCIAABgAAS\/As5k+3wAAAAAAAAAAAAAAAAAAAAAAA AA
    AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\/+M4xAAmNCH9VUlAAYAPYgDLnPqQy0CBAgQIIWRggGGLRo0c985z nOe
    +c0aNG3tIBWK26UQIIWKGJ\/\/8IKCgpQuAoCwPKd3d0qXPf\/3d7hDBcXe4REr9Pe0F3hDE3vRETd34Tl3uHd74T9 ERK
    5cxNy3fQXFz30RJFE3vRNK+ERJISv\/0REr5dErd3uHd3v9He9ET0Svm9Hd+ESpQUFABweAZh4+GPQSSEKSQZG8sO GQeK
    +YLINRg7ATMPMUczw0yQBDMaGoAINm\/\/4AvRi8NBkGAKACwWCP\/\/+M4xDI6I8Jw8Z54AP85XD9+NrUcB9v\/\ /0PU
    cc5zTVcr5HGg2HN\/\/\/\/nfV8f\/KwRh2pgxk4GGLn\/\/\/\/\/Heavp\/HQiDHPwhAsLt+UhOxukBMv\/\/\/ \/\/
    +ZjVZoE4VD4tiEEvZ7vTZQtNj\/L6JkG\/CNKd5\/\/\/\/\/\/\/k\/0eaZByxnQaCEEvjMijT7Ge5AkJJ7KSJF I9pZk
    uvob\/\/\/\/\/\/\/\/+cYRhUaIWaarajkWDoiv0LeaXjQPE04imlV6YqUZuvC\/pI7DLXl1pQAogHb5GmoAytT LKUh"
)
                            

account       =>  [Required]   Filter Call Recordings by Account (Values from getCallAccounts)
email         =>  [Required]   Email to send call recording
callrecording =>  [Required]   Call Recording (Values from getCallRecordings)
                                

Array
(
    [status] => success
    [msg] => Email sent to mail@sonpany.com
)

                            

account       =>  [Required]   Filter Call Recordings by Account (Values from getCallAccounts)
callrecording =>  [Required]   Call Recording (Values from getCallRecordings)
                                

Array
(
    [status] => success
)

                            

client     => ID for a specific Reseller Client (Example: 561115)

Array
(
    [status] => success
    [accounts] => Array
        (
            [0] => Array
                (
                    [value] => all
                    [description] => All Accounts
                )

            [1] => Array
                (
                    [value] => 100000_VoIP
                    [description] => 100000_VoIP
                )
        )
)
                            

No Parameter

Array
(
    [status] => success
    [call_billing] => Array
        (
            [0] => Array
                (
                    [value] => all
                    [description] => All Calls
                )

            [1] => Array
                (
                    [value] => free
                    [description] => Free Calls
                )

            [2] => Array
                (
                    [value] => billed
                    [description] => Billed Calls
                )
        )
)
                            

client     => ID for a specific Reseller Client (Example: 561115)

Array
(
    [status] => success
    [call_types] => Array
        (
            [0] => Array
                (
                    [value] => all
                    [description] => All Calls
                )

            [1] => Array
                (
                    [value] => outgoing
                    [description] => Outgoing Calls
                )

            [2] => Array
                (
                    [value] => incoming
                    [description] => Incoming Calls
                )

            [3] => Array
                (
                    [value] => 5551234567
                    [description] => Calls to 5551234567
                )
        )
)
                            

date_from     => [Required] Start Date for Filtering CDR (Example: '2010-11-30')
date_to       => [Required] End Date for Filtering CDR (Example: '2010-11-30')
answered      =>            Include Answered Calls to CDR (Boolean: 1/0)
noanswer      =>            Include NoAnswered calls to CDR (Boolean: 1/0)
busy          =>            Include Busy Calls to CDR (Boolean: 1/0)
failed        =>            Include Failed Calls to CDR (Boolean: 1/0)
timezone      => [Required] Adjust time of calls according to Timezome (Numeric: -12 to 13)
calltype      =>            Filters CDR by Call Type (Values from getCallTypes)
callbilling   =>            Filter CDR by Call Billing (Values from getCallBilling)
account       =>            Filter CDR by Account (Values from getCallAccounts)                            

Array
(
    [status] => success
    [cdr] => Array
        (
            [0] => Array
                (
                    [date] => 2010-11-30 10:40:16
                    [callerid] => "John Doe" <5551112222>
                    [destination] => 5551234567
                    [description] => Inbound - Local Caller
                    [account] => 100000_VoIP
                    [disposition] => ANSWERED
                    [duration] => 00:00:11
                    [seconds] => 11
                    [rate] => 0.00000000
                    [total] => 0.00000000
                    [uniqueid] => 128238059
                    [destination_type] => IN:USA
                )

            [1] => Array
                (
                    [date] => 2010-09-30 10:36:32
                    [callerid] => "Jane Doe" <5551234567>
                    [destination] => 5551112222
                    [description] => Outbound - Customer
                    [account] => 100000_VoIP
                    [disposition] => ANSWERED
                    [duration] => 00:00:55
                    [seconds] => 55
                    [rate] => 0.00000000
                    [total] => 0.00000000
                    [uniqueid] => 128236206
                    [destination_type] => IN:USA
                )
        )
)
                            

package     => [Required] ID for a specific Package (Example: 92364)
query       => [Required] Query for searching rates (Example: 'Canada')                            

Array
(
    [status] => success
    [rates] => Array
        (
            [0] => Array
                (
                    [destination] => Canada - 418 Quebec City
                    [prefix] => 1418
                    [client_increment] => 60
                    [client_rate] => 0.015
                    [real_increment] => 6
                    [real_rate] => 0.0052
                )

            [1] => Array
                (
                    [destination] => Canada - 581 Quebec City
                    [prefix] => 1581
                    [client_increment] => 60
                    [client_rate] => 0.015
                    [real_increment] => 6
                    [real_rate] => 0.0052
                )
        )
)
                            

route   => [Required] Route Code (Values from getRoutes)(Example: '2')
query   => [Required] Query for searching rates (Example: 'Canada')                            

Array
(
    [status] => success
    [route] => Array
        (
            [value] => 2
            [description] => Premium


        )
    [rates] => Array
        (
            [0] => Array
                (
                    [destination] => Canada - 204 Manitoba
                    [prefix] => 1204
                    [increment] => 6
                    [rate] => 0.009
                )

            [1] => Array
                (
                    [destination] => Canada - 418 Quebec City
                    [prefix] => 1418
                    [increment] => 6
                    [rate] => 0.009
                )
        )
)
                            

date_from       => [Required] Start Date for Filtering CDR (Example: '2010-11-30')
date_to         => [Required] End Date for Filtering CDR (Example: '2010-11-30')
client          => [Required] ID for a specific Reseller Client (Example: 561115)
answered        =>            Include Answered Calls to CDR (Boolean: 1/0)
noanswer        =>            Include NoAnswered calls to CDR (Boolean: 1/0)
busy            =>            Include Busy Calls to CDR (Boolean: 1/0)
failed          =>            Include Failed Calls to CDR (Boolean: 1/0)
timezone        => [Required] Adjust time of calls according to Timezome (Numeric: -12 to 13)
calltype        =>            Filters CDR by Call Type (Values from getCallTypes)
callbilling     =>            Filter CDR by Call Billing (Values from getCallBilling)
account         =>            Filter CDR by Account (Values from getCallAccounts)                            

Array
(
    [status] => success
    [cdr] => Array
        (
            [0] => Array
                (
                    [date] => 2010-11-30 10:40:16
                    [callerid] => "John Doe" <5551112222>
                    [destination] => 5551234567
                    [description] => Inbound - Local Caller
                    [account] => 100000_VoIP
                    [disposition] => ANSWERED
                    [duration] => 00:00:11
                    [seconds] => 11
                    [total] => 0.015
                    [uniqueid] => 128238059
                    [destination_type] => IN:USA
                )

            [1] => Array
                (
                    [date] => 2010-09-30 10:36:32
                    [callerid] => "Jane Doe" <5551234567>
                    [destination] => 5551112222
                    [description] => Outbound - Customer
                    [account] => 100000_VoIP
                    [disposition] => ANSWERED
                    [duration] => 00:00:55
                    [seconds] => 55
                    [total] => 0.015
                    [uniqueid] => 128236206
                    [destination_type] => IN:USA
                )
        )
)
                            

client      => [Required] ID for a specific Reseller Client (Example: 561115)
charge      => [Required] Amount of money that will be Debited from the customer (Example: 4.99)
description =>            Charge Description
test        =>            Set to true if testing how adding charges works                            

Array
(
    [status] => success
)
                            

client      => [Required] ID for a specific Reseller Client (Example: 561115)
payment     => [Required] Amount of money that will be Credited to the customer (Example: 4.99)
description =>            Payment Description
test        =>            Set to true if testing how adding payments works                            

Array
(
    [status] => success
)
                            

did      => [Required] DID Number to be assign into our Vpri (Example: 561115)
vpri     => [Required] Id for specific Vpri


                            

Array
(
    [status] => success
    [vpri] => 5
    [DIDAdded] => 5551234567
    [monthly] => 2.00
)
                            

balance_management     => Code for a specific Balance Management Setting (Example: 1)

Array
(
    [status] => success
    [balance_management] => Array
        (
            [0] => Array
                (
                    [value] => 1
                    [description] => Hard - suspend the client
                )
        )
)
                            

client     => [Required] ID for a specific Reseller Client (Example: 561115)

Array
(
    [status] => success
    [charges] => Array
        (
            [0] => Array
                (
                    [id] => 475568
                    [date] => 2010-10-29
                    [amount] => 2.00
                    [description] => DID5551234567
                )

            [1] => Array
                (
                    [id] => 475567
                    [date] => 2010-10-29
                    [amount] => 1.00
                    [description] => SETUP5551234567
                )

            [3] => Array
                (
                    [id] => 467988
                    [date] => 2010-09-15
                    [amount] => 3.00
                    [description] => SETUPPACKAGE:8378
                )
        )
)
                            

client     => [Required] ID for a specific Reseller Client (Example: 561115)

Array
(
    [status] => success
    [packages] => Array
        (
            [0] => Array
                (
                    [value] => 8378
                    [description] => VoIP
                )
        )
)
                            

client  => Parameter could have the following values:
           * Empty Value [Not Required]
           * Specific Reseller Client ID (Example: 561115)
           * Specific Reseller Client e-mail  (Example: 'john.doe@mydomain.com')                            

Array
(
    [status] => success
    [clients] => Array
        (
            [0] => Array
                (
                    [client] => 561115
                    [email] => john.doe@my-domain.com
                    [password] => johnspassword
                    [company] => Consulting
                    [firstname] => John
                    [lastname] => Doe
                    [address] => 5491 190TH
                    [city] => OPA LOCKA
                    [state] => FLORIDA
                    [country] => UNITED STATES
                    [zip] => 33055
                    [phone_number] => 5551112222
                    [balance_management] => 1
                )
        )
)
                            

client     => [Required] ID for a specific Reseller Client (Example: 561115)

Array
(
    [status] => success
    [threshold_information] => Array
        (
            [threshold] => 130
            [email] => john.doe@my-domain.com
        )

)
                            

client     => [Required] ID for a specific Reseller Client (Example: 561115)

Array
(
    [status] => success
    [deposits] => Array
        (
            [0] => Array
                (
                    [id] => 808639
                    [date] => 2010-10-15
                    [amount] => 4.00
                    [description] => Credit : 2 Setup Charges
                )

            [1] => Array
                (
                    [id] => 808384
                    [date] => 2010-11-30
                    [amount] => 10.00
                    [description] => Want To Keep Positive Balance
                )
        )
)
                            

package    => Code for a specific Package (Example: 8378)

Array
(
    [status] => success
    [packages] => Array
        (
            [0] => Array
                (
                    [package] => 8378
                    [name] => VoIP
                    [markup_fixed] => 0.01
                    [markup_percentage] => 50
                    [pulse] => 60
                    [international_route] => 1
                    [canada_route] => 1
                    [monthly_fee] => 2.00
                    [setup_fee] => 1.00
                    [free_minutes] => 0
                )
        )
)
                            

client     => [Required] ID for a specific Reseller Client (Example: 561115)

Array
(
    [status] => success
    [balance] => Array
        (
            [current_balance] => 8.0588
            [spent_total] => 1.9012
            [calls_total] => 56
            [time_total] => 51:35
            [spent_today] => 0.045
            [calls_today] => 2
            [time_today] => 2:50
        )
)
                            

client                  => [Required] ID for a specific Reseller Client (Example: 561115)
email                   => [Required] Client's e-mail
password                => [Required] Client's Password
company                 =>            Client's Company
firstname               => [Required] Client's Firstname
lastname                => [Required] Client's Lastname
address                 =>            Client's Address
city                    =>            Client's City
state                   =>            Client's State
country                 =>            Client's Country (Values from getCountries)
zip                     =>            Client's Zip Code
phone_number            => [Required] Client's Phone Number
balance_management      =>            Balance Management for Client
                                      (Values from getBalanceManagement)                            

Array
(
    [status] => success
)
                            

client                  => [Required] ID for a specific Reseller Client (Example: 561115)
threshold               => [Required] Threshold amount between 1 and 250 (Example: 10)
email                   =>            Client's e-mail for balance threshold notification                            

Array
(
    [status] => success
)
                            

conference                  => [Required] ID for a specific Conference (Example: 5356)
name                        => [Required] Conference name
description                 => [Required] Conference description
members                     =>            Conference Members
max_members                 => [Required] Members Max Value
sound_join                  =>            The recording played when a user joins, typically some kind of beep sound (Values from getRecordings)
sound_leave                 =>            The recording played when a user leaves, typically some kind of beep sound (Values from getRecordings)
sound_has_joined            =>            The recording played as a user intro (Values from getRecordings)
sound_has_left              =>            The recording played as a user leaves the conference (Values from getRecordings)
sound_kicked                =>            The recording played to a user who has been kicked from the conference (Values from getRecordings)
sound_muted                 =>            The recording played to a user when the mute option is toggled on (Values from getRecordings)
sound_unmuted               =>            The recording played to a user when the mute option is toggled off (Values from getRecordings)
sound_only_person           =>            The recording played when a user is the only person in the conference (Values from getRecordings)
sound_only_one              =>            The recording played to a user when there is only one other person in the conference. (Values from getRecordings)
sound_there_are             =>            The recording played when announcing how many users there are in a conference. (Values from getRecordings)
sound_other_in_party        =>            The recording used in conjunction with the There are option, used like There are (number of participants) Other in party (Values from getRecordings)
sound_place_into_conference =>            The recording played when a user is placed into a conference that cannot start until a marked user enters (Values from getRecordings)
sound_get_pin               =>            The recording played when prompting for a conference PIN (Values from getRecordings)
sound_invalid_pin           =>            The recording played when an invalid PIN is entered too many (3) times (Values from getRecordings)
sound_locked                =>            The recording played to a user trying to join a locked conference (Values from getRecordings)
sound_locked_now            =>            The recording played to an Admin-level user after toggling the conference to locked mode (Values from getRecordings)
sound_unlocked_now          =>            The recording played to an Admin-level user after toggling the conference to unlocked mode (Values from getRecordings)
sound_error_menu            =>            The recording played when there is an error on the menu. (Values from getRecordings)
sound_participants_muted    =>            The recording played when all non-admin participants are muted. (Values from getRecordings)
sound_participants_unmuted  =>            The recording played when all non-admin participants are unmuted. (Values from getRecordings)
language                    =>            Conference Language (Values from getLanguages)
                            

Array
(
    [status] => success
    [conference] => 1234
)
                            

conference                  => [Required] ID for a specific Conference (Example: 5356)
member                      => [Required] ID for a specific Member profile (Example: 5356)
name                        => [Required] Member name.
description                 =>            Member description.
pin                         =>            Assigned PIN.
announce_join_leave         =>            Sets if the conference recording when a member joins or leaves will be played (yes/no).
admin                       =>            Sets if the member is an admin or not (yes/no).
start_muted                 =>            Sets if the member should start out muted after entering the conference (yes/no).
announce_user_count         =>            Sets if the number of members in the conference should be announced to the caller as he joins (yes/no).
announce_only_user          =>            Sets if the "only user" announcement should be played when a caller enters an empty conference (yes/no).
moh_when_empty              =>            Sets whether music on hold (MOH) should be played when only one person is in the conference (Values from getMusicOnHold).
quiet                       =>            When set to "yes", enter/leave prompts and user introductions are not played (yes/no).
announcement                =>            If set, this recording will be heard only by the user as he joins the conference (Values from getRecordings).
drop_silence                =>            The system will drop what is detected as silence from entering into the conference (yes/no).
talking_threshold           =>            The time, in milliseconds, that a users needs to be sending sound or voice before the system can consider them to be talking (allowed values are 100, 120, 140, 160, 180, 200, 220, 240 or 250).
silence_threshold           =>            The time, in milliseconds, that silence needs to be present in the user�s sound stream before the system can consider it to be in fact silent and close the audio (allowed values are 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900 or 3000).
talk_detection              =>            If set to YES, the conference dashboard will display a notification when a participant starts and stops talking (yes/no).
jitter_buffer               =>            When set to YES, the system will place a jitter buffer on the caller's audio stream before any audio mixing is performed (yes/no).
                            

Array
(
    [status] => success
    [member] => 1234
)
                            

sequence                  => [Required] ID for a specific Sequence (Example: 5356)
name                      => [Required] Sequence name
steps                     => [Required] Sequence steps (Example: "[
                                {
                                    "type": "rec",
                                    "id": "1234"
                                },
                                {
                                    "type": "dtmf",
                                    "codes": "1234"
                                },
                                {
                                    "type": "sms",
                                    "from": "1234567890",
                                    "to": "0987654321",
                                    "msg": "This is a test."
                                }
                            ]")

client                    => [Optional] ID for a specific Reseller Client (Example: 561115)                            

Array
(
    [status] => success
    [sequence] => 1234
)
                            

firstname           => [Required] Client's Firstname
lastname            => [Required] Client's Lastname
company             =>            Client's Company
address             => [Required] Client's Address
city                => [Required] Client's City
state               => [Required] Client's State
country             => [Required] Client's Country (Values from getCountries)
zip                 => [Required] Client's Zip Code
phone_number        => [Required] Client's Phone Number
email               => [Required] Client's e-mail
confirm_email       => [Required] Client's Confirmation e-mail
password            => [Required] Client's Password
confirm_password    => [Required] Client's Confirmation Password
activate            =>            Activates Client (Boolean: 1/0)
balance_management  =>            Balance Management for Client
(Values from getBalanceManagement)                            

Array
(
    [status] => success
    [client] => 1234
)
                            

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         = Sound Quality Test

    none        Used to route calls to no action

Examples:
    'account:100001_VoIP'
    'fwd:1026'
    'vm:101'
    'none:'
    'sys:echo'
                            

Array
(
    [status] => success
)
                            

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         = Sound Quality Test

    none        Used to route calls to no action
Examples:
    'account:100001_VoIP'
    'fwd:1026'
    'vm:101'
    'none:'
    'sys:echo'
                            

Array
(
    [status] => success
)
                            

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                            

Array
(
    [status] => success
)
                            

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)
next_billing        =>            Next billing date (Example: '2014-03-30')
dont_charge_setup   =>            If set to true, the setup value will not be charged after Connect
dont_charge_monthly =>            If set to true, the monthly value will not be charged after Connect                            

Array
(
    [status] => success
)
                            

callback    => [Required] ID for a specific Callback (Example: 19183)

Array
(
    [status] => success
)
                            

filtering   => [Required] ID for a specific CallerID Filtering (Example: 19183)

Array
(
    [status] => success
)
                            

callhunting    => [Required] ID for a specific Call Hunting (Example: 323)

Array
(
    [status] => success
)
                            

client    => [Required] ID for a specific Reseller Client (Example: 1998)

Array
(
    [status] => success
)
                            

conference    => [Required] ID for a specific Conference (Example: 737)

Array
(
    [status] => success
)
                            

member    => [Required] ID for a specific Member Profile (Example: 737)

Array
(
    [status] => success
)
                            

sequence    => [Required] ID for a specific Sequence (Example: 5356)
client      => [Optional] ID for a specific Reseller Client (Example: 561115)                            

Array
(
    [status] => success
)
                            

disa    => [Required] ID for a specific DISA (Example: 19183)

Array
(
    [status] => success
)
                            

id    => [Required] ID for a specific SMS (Example: 1918)

Array
(
    [status] => success
)
                            

id    => [Required] ID for a specific MMS (Example: 1918)

Array
(
    [status] => success
)
                            

forwarding     => ID for a specific Forwarding (Example: 19183)

Array
(
    [status] => success
)
                            

ivr    => [Required] ID for a specific IVR (Example: 19183)

Array
(
    [status] => success
)
                            

phonebook  => [Required] ID for a specific Phonebook (Example: 19183)

Array
(
    [status] => success
)
                            

group  => [Required] ID for a specific Phonebook group

Array
(
    [status] => success
)
                            

queue  => [Required] ID for a specific Queue (Example: 13183)

Array
(
    [status] => success
)
                            

recording  => [Required] ID for a specific Recording (Example: 19183)

Array
(
    [status] => success
)
                            

ringgroup  => [Required] ID for a specific Ring Group (Example: 19183)

Array
(
    [status] => success
)
                            

sipuri => [Required] ID for a specific SIP URI (Example: 19183)

Array
(
    [status] => success
)
                            

member => [Required] ID for a specific Member Queue (Example: 1918)
queue  => [Required] ID for a specific Queue (Example: 27183)                            

Array
(
    [status] => success
)
                            

timecondition  => [Required] ID for a specific Time Condition (Example: 19183)

Array
(
    [status] => success
)
                            

callback   => ID for a specific Callback (Example: 2359)

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
                )
        )
)
                            

filtering   => ID for a specific CallerID Filtering (Example: 18915)

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
                )
        )
)
                            

callhunting   => ID for a specific Call Hunting (Example: 323)

Array
(
    [status] => success
    [call_hunting] => Array
        (
            [0] => Array
                (
                    [callhunting] => 13
                    [description] => test
                    [members] => account:11111;none:;none:;none:;none:;none:;none:;none:
                    [ring_time] => 20;20;20;20;20;20;20;20
                    [order] => follow
                    [press] => 1;1;1;1;1;1;1;1
                    [music] => default
                    [recording] => default
                    [language] => en
                )

        )

)
                            

country_id   =>            ID for a specific country (Example: 205)
type         => [Required] Type of International DID (Values from getInternationalTypes)                            

Array
(
    [status] => success
    [countries] => Array
        (
            [0] => Array
                (
                    [value] => 205
                    [description] => SWEDEN (+46)
                )
        )
)
                            

carrier     => Code for a specific Carrier (Example: 2)

Array
(
    [status] => success
    [carriers] => Array
        (
            [0] => Array
                (
                    [value] => 2
                    [description] => American Carrier, American and Canadian Callers allowed
                )
        )
)
                            

province        => [Required] Canadian Province (Values from getProvinces)
ratecenter      =>            Canadian Ratecenter (Values from getRateCentersCAN)                            

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
                )
        )
)
                            

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)                            

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]
                    [port_out_pin] => 1234
                    [billing_type] => 2
                    [next_billing] => 2014-08-30
                    [order_date] => 2014-07-30 15:09:04
                    [reseller_account] => 100001_VoIPReseller
                    [reseller_next_billing] => 2014-08-30
                    [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
                    [smpp_enabled] => 1
                    [smpp_url] => http://myurl.com
                    [smpp_user] =>
                    [smpp_pass] =>
                    [transcribe] => 1
                    [transcription_locale] => en-US
                    [transcription_email] => test@example.com
                )
        )
)

                            

country_id => [Required] ID for a specific Country (Values from getDIDCountries)

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
                )
        )
)
                            

country_id => [Required] ID for a specific Country (Values from getDIDCountries)

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
                )
        )
)
                            

country_id => [Required] ID for a specific Country (Values from getDIDCountries)

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
                )
        )
)
                            

state         => [Required] United States State (Values from getStates)
ratecenter    =>            United States Ratecenter (Values from getRateCentersUSA)                            

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
                    [has_port_out_pin] => 1
                    [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
                    [has_port_out_pin] => 0
                    [sms] => 1
                )
        )
)
                            

vpri  => [Required] Id for specific Vpri
                            

Array
(
    [status] => success
    [status] => vpri
    [dids] => Array
        (
            [0] => 7862285619
            [1] => 7862285871
        )
)
                            

disa   => ID for a specific DISA (Example: 2114)

Array
(
    [status] => success
    [disa] => Array
        (
            [0] => Array
                (
                    [disa] => 2114
                    [name] => Jonhs DISA
                    [pin] => 1234
                    [digit_timeout] => 10
                    [callerid_override] => 5552223333
                )
        )
)
                            

forwarding     => ID for a specific Forwarding (Example: 18635)

Array
(
    [status] => success
    [forwardings] => Array
        (
            [0] => Array
                (
                    [forwarding] => 18635
                    [phone_number] => 5553334444
                    [callerid_override] => 5551234567
                    [description] => RESELLER| 5553334444
                    [dtmf_digits] => 123
                    [pause] => 1.5
                )
        )
)
                            

type   => Code for a specific International Type (Example: 'NATIONAL')

Array
(
    [status] => success
    [types] => Array
        (
            [0] => Array
                (
                    [value] => NATIONAL
                    [description] => National Numbers (Non-Geographical)
                )
        )
)
                            

ivr   => ID for a specific IVR (Example: 4636)

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
                )
        )
)
                            

type   => Code for a specific 'JoinWhenEmpty' Type (Example: 'yes')

Array
(
    [status] => success
    [types] => Array
        (
            [0] => Array
                (
                    [value] => yes
                    [description] => Yes
                )

        )

)
                            

phonebook   => ID for a specific Phonebook entry (Example: 32207)
name        => Name to be searched in database   (Example: 'jane')
group       => ID for a specific Phonebook group
group_name  => Group Name                            

Array
(
    [status] => success
    [phonebooks] => Array
        (
            [0] => Array
                (
                    [phonebook] => 32207
                    [speed_dial] => *7501
                    [name] => Jane Smith
                    [number] => 5553334444
                    [callerid] => 5552223333
                    [note] => Janes Mobile
                    [group] => 3220
                    [group_name] => Work
                )
        )
)
                            

group       => ID for a specific Phonebook group
name        => Group Name                            

Array
(
    [status] => success
    [phonebooks] => Array
        (
            [0] => Array
                (
                    [phonebook_group] => 32207
                    [name] => Work
                    [members] => 123456;654321
                )
        )
)
                            

did  => [Required] DID Number to be ported into our network (Example: 5552341234)

Array
(
    [status] => success
    [portable] => yes
    [sms] => 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
                )

        )

)
                            

recording  => ID for a specific Recording (Example: 7567)

Array
(
    [status] => success
    [recordings] => Array
        (
            [0] => Array
                (
                    [value] => 7567
                    [description] => IVR Recording
                )
        )
)
                            

recording  => [Required] ID for a specific Recording (Example: 7567)

Array
(
    [status] => success
    [recordings] => Array
        (
            [0] => Array
                (
                    [value] => 7567
                    [data] => UklGRqTEAQBXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YYDEA....
                )
        )
)
                            

ring_group  => ID for a specific Ring Group (Example: 4768)

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
                )
        )
)
                            

strategy  =>            ID for a specific Ring Strategy (Example: 'rrmemory')

Array
(
    [status] => success
    [strategies] => Array
        (
            [0] => Array
                (
                    [value] => rrmemory
                    [description] => Round Robin Memory
                )

        )

)
                            

sipuri  => ID for a specific SIP URI (Example: 6199)

Array
(
    [status] => success
    [sipuris] => Array
        (
            [0] => Array
                (
                    [sipuri] => 6199
                    [uri] => 5552223333@sip.voip.ms
                    [description] => Jonh Smith
                    [callerid_override] => 529999999
                    [callerid_e164] => 1
                )
        )
)
                            

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)

all_messages=>          Filter to recive all SMSs and MMSs, 1 recive all SMS and MMS, 0 if only need SMS, important: the sms ID must be 0
                            

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
                )

        )

)
                            

mms     =>          ID for a specific MMS (Example: 1918)
from    =>          Start Date for Filtering MMSs (Example: '2014-03-30')
                    - Default value: Today
to      =>          End Date for Filtering MMSs (Example: '2014-03-30')
                    - Default value: Today
type    =>          Filter MMSs by Type (Boolean: 1 = received / 0 = sent)
did     =>          DID number for Filtering MMSs (Example: 5551234567)
contact =>          Contact number for Filtering MMSs (Example: 5551234567)
limit   =>          Number of records to be displayed (Example: 20)
                    - Default value: 50
timezone=>          Adjust time of MMSs according to Timezome (Numeric: -12 to 13)

all_messages=>          Filter to recive all MMSs and SMSs, 1 recive all SMS and MMS, 0 if only need MMS, important: the sms ID must be 0                              

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
                    [col_media1] => "https://voip.ms/media.php?map=MTU5MzUzMDcTk2NNUw=="
                    [col_media2] => ""
                    [col_media3] => ""
                    [media] => Array
                    (
                        [0] =>'https://voip.ms/media.php?map=MTU5MzUzMDcTk2NNUw=='
                        [1] =>''
                        [2] =>''
                    )
                )

        )

)
                            

id              =>  ID for a specific MMS (Example: 1918)
media_as_array  =>  Return the list of media attachments as an Array if the value is 1 or as a JSON Object if the value is 0 (Default: 0)                            

Array
(
    [status] => success
    [id] => 272377221
    [date] => 2014-03-30 10:24:16
    [media] =>
        (
            [0] =>'https://voip.ms/media.php?map=MTU5MzUzMDcTk2NNUw=='
            [1] =>''
            [2] =>''
        )
)

                            

No Parameter

Array
(
    [status] => success
    [provinces] => Array
        (
            [0] => Array
                (
                    [province] => ON
                    [description] => ONTARIO
                )

            [1] => Array
                (
                    [province] => QC
                    [description] => QUEBEC
                )

            [2] => Array
                (
                    [province] => AB
                    [description] => ALBERTA
                )
        )
)
                            

queue   =>          ID for a specific Queue (Example: 4764)                            

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:
                )
        )
)
                            

province   => [Required] Canadian Province (Values from getProvinces)

Array
(
    [status] => success
    [ratecenters] => Array
        (
            [0] => Array
                (
                    [ratecenter] => Calgary
                    [available] => yes
                )

            [1] => Array
                (
                    [ratecenter] => Canmore
                    [available] => yes
                )

            [2] => Array
                (
                    [ratecenter] => Edmonton
                    [available] => yes
                )
        )
)
                            

state      => [Required] United States State (Values from getStates)

Array
(
    [status] => success
    [ratecenters] => Array
        (
            [0] => Array
                (
                    [ratecenter] => ALFORD
                    [available] => no
                )

            [1] => Array
                (
                    [ratecenter] => APOPKA
                    [available] => yes
                )

            [2] => Array
                (
                    [ratecenter] => ARCADIA
                    [available] => yes
                )
        )
)
                            

No Parameter

Array
(
    [status] => success
    [states] => Array
        (
            [0] => Array
                (
                    [state] => AL
                    [description] => ALABAMA
                )

            [1] => Array
                (
                    [state] => AR
                    [description] => ARKANSAS
                )

            [2] => Array
                (
                    [state] => AZ
                    [description] => ARIZONA
                )
        )
)
                            

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                            

Array
(
    [status] => success
    [members] => Array
        (
            [0] => Array
                (
                    [member] => 163
                    [queue_number] => 4136
                    [name] => as
                    [account] => SIP/10000_johnsmith
                    [priority] => 0
                )

        )

)
                            

timecondition  => ID for a specific Time Condition (Example: 1830)

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
                )
        )
)
                            

voicemailsetup => ID for a specific Voicemail Setup (Example: 2)

Array
(
    [status] => success
    [voicemailsetups] => Array
        (
            [0] => Array
                (
                    [value] => 2
                    [description] => Account Voicemail
                )
        )
)
                            

email_attachment_format => ID for a specific attachment format (Example: wav49)

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
                )

        )

)
                            

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         = Sound Quality Test


    none        Used to route calls to no action

Examples:    'account:100001_VoIP'
    'fwd:1026'
    'vm:101'
    'none:'
    'sys:echo'
                            

Array
(
    [status] => success
)
                            

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         = Sound Quality Test

    none        Used to route calls to no action

Examples:    'account:100001_VoIP'
    'fwd:1026'
    'vm:101'
    'none:'
    'sys:echo'
                            

Array
(
    [status] => success
)
                            

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         = Sound Quality Test


    none        Used to route calls to no action

Examples:    'account:100001_VoIP'
    'fwd:1026'
    'vm:101'
    'none:'
    'sys:echo'
                            

Array
(
    [status] => success
)
                            

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         = Sound Quality Test

    none        Used to route calls to no action

Examples:    'account:100001_VoIP'
    'fwd:1026'
    'vm:101'
    'none:'
    'sys:echo'
                            

Array
(
    [status] => success
)
                            

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         = Sound Quality Test

    none        Used to route calls to no action

Examples:    'account:100001_VoIP'
    'fwd:1026'
    'vm:101'
    'none:'
    'sys:echo'
                            

Array
(
    [status] => success
)
                            

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         = Sound Quality Test

    none        Used to route calls to no action

Examples:    'account:100001_VoIP'
    'fwd:1026'
    'vm:101'
    'none:'
    'sys:echo'
                            

Array
(
    [status] => success
)
                            

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         = Sound Quality Test


    none        Used to route calls to no action

Examples:    'account:100001_VoIP'
    'fwd:1026'
    'vm:101'
    'none:'
    'sys:echo'
                            

Array
(
    [status] => success
)
                            

vpri  =>            Id for specific Vpri
did   => [Required] DID Number to be remove from our Vpri (Example: 561115)
                            

Array
(
    [status] => success
    [vpri] => 358
    [DIDRemoved] => 561115

)
                            

province      =>            Canadian Province (Values from getProvinces)
type          => [Required] Type of search (Values: 'starts', 'contains', 'ends')
query         => [Required] Query for searching (Examples: 'JOHN', '555', '123ABC')                            

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
                )
        )
)
                            

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')                            

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
                )
        )
)
                            

type          => Type of search (Values: 'starts', 'contains', 'ends')
query         => Query for searching (Examples: 'JOHN', '555', '123ABC')                            

Array
(
    [status] => success
    [dids] => Array
        (
            [0] => Array
                (
                    [did] => 8774530644
                    [monthly] => 1.49
                    [minute] => 0.0320
                    [setup] => 0.00
                )
        )
)
                            

type          => Type of search (Values: 'starts', 'contains', 'ends')
query         => Query for searching (Examples: 'JOHN', '555', '123ABC')                            

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                            

type          => [Required] Type of Vanity Number
                            Values: '8**', '800', '833', '844', '855', '866', '877', '888'
query         => [Required] Query for searching : 7 Chars
                            Examples: '***JHON', '**555**', '**HELLO'                            

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
                )
        )
)
                            

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)                            

Array
(
    [status] => success
    [sms] => 23434
)
                            

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: 2048)

media1     => [Optional]  Url to media file (Example: 'https://voip.ms/themes/voipms/assets/img/talent.jpg?v=2'
media2     => [Optional] Base 64 image encode (Example: data:image/png;base64,iVBORw0KGgoAAAANSUh...)

media3    => [Optional] Empty value (Example: '' )                            

Requests can be made by the GET and POST methods. When sending multimedia via POST and base64, the file limit is based on the maximum allowed per message, 1.2 mb per file.
When sending multimedia via GET and base64, the file limit is based on the maximum allowed by the GET request type, which supports a length of 512 characters, approximately 160kb total weight.
In both GET and POST when using file URL submission, this limitation does not exist.

Array
(
    [status] => success
    [mms] => 23434
)
                            

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
                            

Array
(
    [status] => success
    [callback] => 2359
)
                            

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 = Not North American format, 0 = Anonymous, NPANXXXXXX, s or sb or sc = STIR/SHAKEN Attestation Level, p = All Phone Book, p:XXXX = Specific Phone Book Group)
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                            

Array
(
    [status] => success
    [filtering] => 18915
)
                            

callhunting         => ID for a specific Call Hunting (Example: 235 / Leave empty to create a new one)
description         => [Required] Description for the Call Hunting
music               => [Required] Music on Hold Code (Values from getMusicOnHold)
recording           => [Required] Recording for the Call Hunting (values from getRecordings)
language            => [Required] Language for the Call Hunting (values from getLanguages)
order               => [Required] The members will be called in follow or random order (values follow or random)
members             => [Required] The list of members assigned to the call hunting
ring_time           => [Required] The Maximum amount of time the call will ring the member
press               => [Required] This option confirm if the member will take the call by pressing 1
                            

Array
(
    [status] => success
    [call_hunting] => 235
)
                            

did                     => [Required] DID affected by the new billing plan
billing_type            => [Required] Billing type for the DID (1 = Per Minute, 2 = Flat)                            

Array
(
    [status] => success
)
                            

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
record_calls          =>             Record Calls (Boolean: 1/0)
note                  =>            Note for the DID
port_out_pin          =>            Port Out PIN protection is used as a means of authorizing outgoing portability (only for selected US numbers with the lock icon)
billing_type          => [Required] Billing type for the DID (1 = Per Minute, 2 = Flat)
transcribe            =>            Enable Call Transcription (Boolean: 1/0)
transcription_locale  =>            Call Transcription Locale (values from getLocales)
transcription_email   =>            Call Transcription Email
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         = Sound Quality Test

    none        Used to route calls to no action

Examples:    'account:100001_VoIP'
    'fwd:1026'
    'vm:101'
    'none:'
    'sys:echo'

                            

Array
(
    [status] => success
)
                            

did     => [Required] DID to be Updated (Example: 5551234567)
pop     => [Required] Point of Presence for the DID ("server_pop" values from getServersInfo. Example: 3)
                            

Array
(
    [status] => success
)
                            

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'
                            

Array
(
    [status] => success
)
                            

did         => [Required] DID to be Updated (Example: 5551234567)
voicemail   =>            Mailbox for the DID                            

Array
(
    [status] => success
)
                            

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                            

Array
(
    [status] => success
    [disa] => 2114
)
                            

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)                            

Array
(
    [status] => success
    [forwarding] => 19183
)
                            

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')                            

Array
(
    [status] => success
    [ivr] => 4636
)
                            

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
note        =>          Note for the phonebook entry
group       =>          ID for a specific Phonebook group                            

Array
(
    [status] => success
    [phonebook] => 32207
)
                            

group       =>            ID for a specific Phonebook group
                          (Example: 32207 / Leave empty to create a new one)
name        => [Required] Name for the Phonebook group
members     =>            Phonebook entry codes associated to this group separated by a semicolon                            

Array
(
    [status] => success
    [group] => 32207
)
                            

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)                            

Array
(
    [status] => success
    [recording] => 33221
)
                            

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'
                            

Array
(
    [status] => success
    [queue] => 32208
)
                            

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)                            

Array
(
    [status] => success
    [ring_group] => 4768
)
                            

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
callerid_override  =>            This setting is optional.  You can  configure a 'CallerID Number Override'.
                                 Your default CallerID number will be changed to the override you have configured
                                 here when using this SIP URI.
callerid_e164      =>            If this option is Enabled, then your CallerID will be E164 compliant.                            

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.

smpp_enabled   =>           If Enable, SMS Messages received by your DID will be sent to the specified SMPP URL (Values:1=Enable / 0=Disable)
smpp_url      =>            SMS Messages received by your DID will be sent to the specified SMPP URL using the submit_sm command. The URL needs to specify if we should send the message encrypted or not using smpp (not encrypted) or ssmpp (encrypted). You can also specify the username, password, and the port in the URL.
smpp_user     =>            The SMPP Username that will be used to authenticate you. Outgoing messages should be sent to smpp.voip.ms through the regular 2775 port or the encrypted 3550 port. These messages can be sent using either deliver_sm or submit_sm commands.
smpp_pass     =>            The SMPP Password that will be used to authenticate you. Outgoing messages should be sent to smpp.voip.ms through the regular 2775 port or the encrypted 3550 port. These messages can be sent using either deliver_sm or submit_sm commands.
                            

Array
(
    [status] => success
    [sipuri] => 6199
)
                            

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)

Array
(
    [status] => success
    [member] => 619
)
                            

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')                            

Array
(
    [status] => success
    [timecondition] => 1830
)
                            

did     => [Required] DID to be Unconnected from Reseller Sub Account(Example: 5551234567)

Array
(
    [status] => success
)
                            

did                 => [Required] FAX DID to be Connected to Reseller 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)
next_billing        =>            Next billing date (Example: '2014-03-30')
dont_charge_setup   =>            If set to true, the setup value will not be charged after Connect
dont_charge_monthly =>            If set to true, the monthly value will not be charged after Connect                            

Array
(
    [status] => success
)
                            

did     => [Required] FAX DID to be Unconnected from Reseller Sub Account (Example: 5551234567)

Array
(
    [status] => success
)
                            

id      =>  [Required] ID for a specific Fax Number (Example: 923)
test    =>  Set to true if testing how cancel a Fax Number                            

Array
(
    [status] => success
    [deleted_did] => 5551234567
)
                            

id      =>  [Required] ID for a specific Fax Message (Example: 923)
test    =>  Set to true if testing how cancel a Fax Message                            

Array
(
    [status] => success
)
                            

id      =>  [Required] ID for a specific "Email To Fax Configuration" (Example: 923)
test    =>  Set to true if testing how cancel a "Email To Fax Configuration"                            

Array
(
    [status] => success
)
                            

id      =>  [Required] ID for a specific Fax Folder (Example: 923)
test    =>  Set to true if testing how to delete a Fax Folder                            

Array
(
    [status] => success
)
                            

id => ID for a specific backorder DID

Array
(
    [status] => success
    [quantity] => 1
    [back_orders] => Array
        (
            [0] => Array
                (
                    [id] => 1234
                    [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
                    [billing_type] => 2
                    [order_date] => 2014-07-30 15:09:04
                )
        )
)
                            

province     => CODE for a specific Province (Example: AB)

Array
(
    [status] => success
    [provinces] => Array
        (
            [0] => Array
                (
                    [province] => AB
                    [province_id] => 60
                    [province_name] => Alberta
                    [country_code] => CAN
                )
        )
)
                            

state     => CODE for a specific State (Example: AL)

Array
(
    [status] => success
    [states] => Array
        (
            [0] => Array
                (
                    [state] => AL
                    [state_id] => 1
                    [state_name] => Alabama
                    [country_code] => USA
                )
        )
)
                            

province      =>  [Required] Province two letters code (Example: AB)                            

Array
(
    [status] => success
    [ratecenters] => Array
        (
            [0] => Array
                (
                    [location] => 20294
                    [area_code] => 587
                    [ratecenter] => EDMONTON
                    [available] => yes
                )
        )
)
                            

state      =>  [Required] Province two letters code (Example: AL)                            

Array
(
    [status] => success
    [ratecenters] => Array
        (
            [0] => Array
                (
                    [location] => 1196
                    [area_code] => 205
                    [ratecenter] => ALABASTER
                    [available] => yes
                )
        )
)
                            

did      =>  Fax Number to retrieves the information of a single number, or not send if 
you want retrieves the information of all your Fax Numbers.                            

Array
(
    [status] => success
    [numbers] => Array
        (
            [0] => Array
                (
                    [id] => 0000
                    [did] => 5551234567
                    [description] => United States, CA, HALF MOON BAY
                    [state] => CA
                    [city] => HALF MOON BAY
                    [country] => United States
                    [email_enabled] => 1
                    [email] => address@email.com
                    [url_enabled] => 1
                    [url] => www.example.com
                    [retry] => 0
                    [attach_file] => 1
                    [note] => "testing"
                    [reseller_account] => 100001_VoIPReseller
                    [reseller_next_billing] => 2014-08-30
                    [reseller_monthly] => 0.00000000
                    [reseller_minute] => 0.01000000
                    [reseller_setup] => 0.00000000
                    [fax_to_sip_enabled] => 1
                    [fax_to_sip_enabled_account] => 100001_VoIPReseller2
                )
        )
)
                            

did      =>  [Required] DID Number to be ported into our network (Example: 5552341234)                            

Array
(
    [status] => success
    [getFaxNumbersPortability] => yes
)
                            

from      =>    Start Date for Filtering Fax Messages (Example: '2014-03-30') - Default value: Today
to        =>    End Date for Filtering Fax Messages (Example: '2014-03-30') - Default value: Today
folder    =>    Name of specific Fax Folder (Example: SENT) - Default value: ALL
id        =>    ID for a Specific Fax Message (Example: 23434)                            

Array
(
    [status] => success
    [faxes] => Array
        (
            [0] => Array
                (
                    [id] => 0000
                    [folder] => INBOX
                    [date] => 2016-01-01 00:00:00
                    [callerid] => 5552341234
                    [stationid] => 5552341234
                    [destination] => 7772341234
                    [description] => INBOUND FAX
                    [pages] => 2
                    [duration] => 1:16
                    [status] => SUCCESS
                    [rate] => 0.000
                    [total] => 0.000
                    [msg] =>
                )
        )
)
                            

id      =>    [Required] ID of the Fax Message requested (Values from getFaxMessages)                            

Array
(
    [status] => success
    [message_base64] => PDF file encrypted in Base64
)
                            

Array
(
    [status] => success
    [folders] => Array
        (
            [0] => Array
                (
                    [id] => 0000
                    [name] => INBOX
                )
        )
)
                            

                                    ID of the "Email to Fax" configuration                            

Array
(
    [status] => success
    [emailToFax] => Array
        (
            [0] => Array
                (
                    [id] => 0000
                    [enabled] => 1
                    [email] => your@email.com
                    [security_code] => 12345
                    [security_code_enabled] => 1
                    [from] => 5552341234
                )
        )
)
                            

id      =>    [Required] ID of the Fax Message requested (Values from getFaxMessages)
email   =>    [Required] Destination email adreess (example: yourname@company.com)                            

Array
(
    [status] => success
    [message_status] => message_sent
)
                            

fax_id      =>    [Required] ID of the Fax Message requested (Values from getFaxMessages)
folder_id   =>    [Required] ID of the destination Fax Folder (Values from getFaxFolders)
test        =>    Set to true if testing how to move a Fax Message                            

Array
(
    [status] => success
)
                            

location            =>    [Required] Location ID of the Fax Number (Values from getFaxRateCentersCAN/getFaxRateCentersUSA)
quantity             =>    [Required] Quantity of Fax Numbers to order (Example: 3)
email               =>    Email address where send notifications when receive Fax Messages
                          - (Example: yourname@company.com)
email_enable        =>    Flag to enable the email notifications.
                          - (Values: 1 = true, 0 = false) - Default: 0
email_attach_file   =>    Flag to enable attach the Fax Message as a PDF file in the notifications.
                          - (Values: 1 = true, 0 = false) - Default: 0
url_callback        =>    URL where make a POST when you receive a Fax Message.
url_callback_enable =>    Flag to enable the URL Callback functionality.
                          - (Values: 1 = true, 0 = false) - Default: 0
url_callback_retry  =>    Flag to enable retry the POST action in case we don't receive "ok".
test                =>      Set to true if testing how Orders work
                            - Orders can not be undone
                            - When testing, no Orders are made                            

Array
(
    [status] => success
    [dids]   => array(
        [0] => 5552341234
        [1] => 5552341234
        [2] => 5552341234
        ...
    )
)
                            

name        =>    [Required] Name of the Fax Folder to create or update (Example: FAMILY)
id          =>    [Only for updates] ID of the Fax Folder to edit (Values from getFaxFolders)
test        =>    Set to true if testing how to create/update a Fax Folder                            

Array
(
    [status] => success
)
                            

id                    =>    [Only for updates] ID of the "Email to Fax" to edit (Values from getEmailToFax)
enabled               =>    If Enable, we will send Fax Message when we receive an email from the provided address. (Values:1=Enable / 0=Disable)
auth_email            =>    [Required] Email address from you will sent Fax Messages
from_number_id        =>    [Required] Fax number that will appear as fax sender. (values from getFaxNumbersInfo)
security_code_enabled =>    If Enable, we will check the mail subject if this include a Security Code before send the Fax. (Values:1=Enable / 0=Disable)
security_code         =>    [Required] An alphanumeric code to identify your emails before send as Fax.
test                  =>    Set to true if testing.                            

Array
(
    [status] => success
)
                            

area_code   =>    [Required] Area code number, as the initial of the Fax Number you looking for. (values from getFaxRateCentersCAN)                            

Array
(
    [status] => success
    [ratecenters]   => array(
        [0] => Array
            (
                [ratecenter] => ACTON
                [area_code] => 226
                [available] => yes
            )
    )
)
                            

area_code   =>    [Required] Area code number, as the initial of the Fax Number you looking for. (values from getFaxRateCentersUSA)                            

Array
(
    [status] => success
    [ratecenters]   => array(
        [0] => array(
            [ratecenter] => COLD SPRING
            [area_code]  => 845
            [available]  => yes
        )
    )
)
                            

did                         =>  [Required] DID Number to be ported into our network (Example: 5552341234)
email                       =>  Email address where send notifications when receive Fax Messages
                                - (Example: yourname@company.com)
email_enable                =>  Flag to enable the email notifications.
                                - (Values: 1 = true, 0 = false) - Default: 0
email_attach_file           =>  Flag to enable attach the Fax Message as a PDF file in the notifications.
                                - (Values: 1 = true, 0 = false) - Default: 0
url_callback                =>  URL where make a POST when you receive a Fax Message.
url_callback_enable         =>  Flag to enable the URL Callback functionality.
                                - (Values: 1 = true, 0 = false) - Default: 0
url_callback_retry          =>  Flag to enable retry the POST action in case we don't receive "ok".
fax_to_sip_enabled          =>  Flag to enable Fax to SIP.
                                - (Values: 1 = true, 0 = false) - Default: 0
fax_to_sip_enabled_account  =>  Fax to SIP subaccount to use (Values from getSubaccounts) Eg: ######_SubAccount.
note                        =>  Description you wish to indicate for this DID (for your own use, but not mandatory).

test                        =>  Set to true if testing how to update the information of a Fax Number                            

Array
(
    [status] => success
)
                            

did                 =>    [Required] DID Number to be ported into our network (Example: 5552341234)
email               =>    Email address where send notifications when receive Fax Messages
                          - (Example: yourname@company.com)
email_enable        =>    Flag to enable the email notifications.
                          - (Values: 1 = true, 0 = false) - Default: 0
email_attach_file   =>    Flag to enable attach the Fax Message as a PDF file in the notifications.
                          - (Values: 1 = true, 0 = false) - Default: 0
test                =>    Set to true if testing how to set the email of a Fax Number                            

Array
(
    [status] => success
)
                            

did                 =>    [Required] DID Number to be ported into our network (Example: 5552341234)
url_callback        =>    URL where make a POST when you receive a Fax Message.
url_callback_enable =>    Flag to enable the URL Callback functionality.
                          - (Values: 1 = true, 0 = false) - Default: 0
url_callback_retry  =>    Flag to enable retry the POST action in case we don't receive "ok".
test                =>    Set to true if testing how to set the URL callback of a Fax Number                            

Array
(
    [status] => success
)
                            

to_number           =>    [Required] Destination DID Number (Example: 5552341234)
from_name           =>    [Required] Name of the sender (Example: 5552341234)
from_number         =>    [Required] DID number of the Fax sender
send_email_enabled  =>    Flag to enable the send of a copy of your Fax via email.
                          - (Values: 1 = true, 0 = false) - Default: 0
send_email          =>    Email address where you want send a copy of your Fax.
station_id          =>    An word to identify a equipment or department sending the Fax.
file                =>    [Required] The file must be encoded in Base64, and in one of the following formats: pdf, txt, jpg, gif, png, tif
test                =>    Set to true if testing how to send a Fax Message                            

Array
(
    [status] => success
)
                            

type        => Code for a specific Address Type (Example: Apartment)                            

Array
(
    [status] => success
    [types] => Array(
                Array (
                    [value] => "Apartment",
                    [description] => "Apartment"
                ),
                Array (
                    [value] => "Basement",
                    [description] => "Basement"
                )
            )
)
                            

did       => [Required] DID to be canceled.
                            

Array
(
    [status] => success
)
                            

did       => [Required] DID with e911 enabled / in process.
                            

Array
(
    [status] => success
    [info] => Array (
        [did] => "7472127447",
        [status] => "2",
        [full_name] => "test",
        [street_number] => "23",
        [street_name] => "W BROAD ST",
        [address_type] => "Hanger",
        [address_number] => "401",
        [city] => "RICHMOND",
        [state] => "VA",
        [zip_code] => "12345",
        [country] => "US",
        [language] => "EN",
        [email] => "john.doe@my-domain.com",
        [other_info] => ""
    )
)
                            

did            => [Required] DID that will be sent to the e911 service.
full_name      => [Required] Full Name that will be sent to the e911 service.
street_number  => [Required] Street Number that will be sent to the e911 service.
street_name    => [Required] Street Name that will be sent to the e911 service.
address_type   => Address Type that will be sent to the e911 service (Values from e911AddressTypes).
address_number => Address Number that will be sent to the e911 service.
city           => [Required] City that will be sent to the e911 service.
state          => [Required] State / Province that will be sent to the e911 service.
country        => [Required] Country that will be sent to the e911 service.
                  Value can be US (United states) or CA (Canada).
zip_code       => [Required] Zip / Postal code that will be sent to the e911 service.
language       => [Required] Language that will be sent to the e911 service.
                  Only available for addresses from Canada.
                  Value can be EN (English) or FR (French).
email          => [Required] Email that will be sent to the e911 service.
other_info     => Additional Address Information that will be sent to the e911 service.
                  Only available for addresses from Canada.
                            

Array
(
    [status] => success
)
                            

did            => [Required] DID that will be sent to the e911 service.
full_name      => [Required] Full Name that will be sent to the e911 service.
street_number  => [Required] Street Number that will be sent to the e911 service.
street_name    => [Required] Street Name that will be sent to the e911 service.
address_type   => Address Type that will be sent to the e911 service (Values from e911AddressTypes).
address_number => Address Number that will be sent to the e911 service.
city           => [Required] City that will be sent to the e911 service.
state          => [Required] State / Province that will be sent to the e911 service.
country        => [Required] Country that will be sent to the e911 service.
                  Value can be US (United states) or CA (Canada).
zip_code       => [Required] Zip / Postal code that will be sent to the e911 service.
language       => [Required] Language that will be sent to the e911 service.
                  Only available for addresses from Canada.
                  Value can be EN (English) or FR (French).
email          => [Required] Email that will be sent to the e911 service.
other_info     => Additional Address Information that will be sent to the e911 service.
                  Only available for addresses from Canada.
                            

Array
(
    [status] => success
)
                            

did            => [Required] DID with e911 enabled / in process.
full_name      => [Required] Full Name that will be updated to the e911 service.
street_number  => [Required] Street Number that will be updated to the e911 service.
street_name    => [Required] Street Name that will be updated to the e911 service.
address_type   => Address Type that will be updated to the e911 service (Values from e911AddressTypes).
address_number => Address Number that will be updated to the e911 service.
city           => [Required] City that will be updated to the e911 service.
state          => [Required] State / Province that will be updated to the e911 service.
country        => [Required] Country that will be updated to the e911 service.
                  Value can be US (United states) or CA (Canada).
zip_code       => [Required] Zip / Postal code that will be updated to the e911 service.
language       => [Required] Language that will be updated to the e911 service.
                  Only available for addresses from Canada.
                  Value can be EN (English) or FR (French).
email          => [Required] Email that will be updated to the e911 service.
other_info     => Additional Address Information that will be updated to the e911 service.
                  Only available for addresses from Canada.
                            

Array
(
    [status] => success
)
                            

did            => [Required] DID with e911 enabled / in process.
full_name      => [Required] Full Name that will be validated.
street_number  => [Required] Street Number that will be validated.
street_name    => [Required] Street Name that will be validated.
address_type   => Address Type that will be validated (Values from e911AddressTypes).
address_number => Address Number that will be validated.
city           => [Required] City that will be validated.
state          => [Required] State / Province that will be validated.
country        => [Required] Country that will be validated.
                  Value can be US (United states) or CA (Canada).
zip_code       => [Required] Zip / Postal code that will be validated.
language       => Language that will be validated.
                  Only available for addresses from Canada.
                  Value can be EN (English) or FR (French).
email          => [Required] Email that will be validated.
other_info     => Additional Address Information that will be validated.
                  Only available for addresses from Canada.
                            

Array
(
    [status] => success
)
                            

numbers         => [Required] DID(s) to port into VoIP.ms network (Example: 5552341234,5552341233). If you
                            are porting more than one number, please separate them with commas.
portType        => [Required] Digits from 1 to 4:
                            1: United States Local numbers
                            2: Canadian Local Numbers
                            3: US/CA Toll Free Numbers
                            4: United States Fax numbers
                            5: Canadian Fax Numbers

isPartial       => If you have more then 1 number with your current carrier and not porting them all, choose yes.
                            If you are porting all the numbers, choose no. Please note that you still need to include all numbers
                            you want to port. If you have 2 numbers and want to port both, you need to include both numbers in the
                            list of numbers to port.
                            - (Values: 1 = true, 0 = false) - Default: 0

locationType    => - (Values: 1 = Business, 0 = Residential) - Default: 0
isMobile        => - (Values: 1 = All the numbers are mobile numbers, 0 = false) - Default: 0
snn             => - 4 Digits of the SNN, required if port type is 1 (USA Local) or 4 (USA Fax)
pin             => PIN Number
imei             => [Required If portType = 2 or portType = 5] If you are porting your mobile number(s), please provide the IMEI*. To get the IMEI*
                            of your phone, you can dial *#06#
btn             => [Required If isMobile = 1] BTN: It is the phone number to which all the other numbers of the customer are
                            charged, in a consolidated telephone bill (instead of showing separate charges for each number you own).
                            Please try to find the BTN on your invoice, and if you are unable to do so please contact the current
                            provider to obtain it.
services        => [Required If isMobile = 1] Please be specific and describe ALL remaining services with the current carrier. This includes DSL/Data
                            services, Hunt Group services, etc. Any services NOT listed below may be disconnected upon completion
                            of this port order.
tfType          => [Required If portType = 3] Values: 1 - American Carrier, American Callers Only, 2 - American Carrier, American
                            and Canadian Callers allowed, 3 - Canadian Carrier
statementName   => [Required] This is for Business numbers only. Please type your Company Name if applicable, otherwise leave it blank.
firstName       => [Required] This is the "Customer First Name" as it appears on  the CSR (Customer Service Record) of the
                            losing carrier. Please Enter the first name of the owner of the number or the autorized contact. No company
                            name must be entered in the field.
lastName        => [Required] This is the "Customer Last Name" as it appears on  the CSR (Customer Service Record) of the
                            losing carrier. Please Enter the last name of the owner of the number or the autorized contact. No company
                            name must be entered in the field
address1        => [Required] This is the "Customer Address" as it appears on the CSR (Customer Service Record) of the losing carrier.
address2        => Optional Address information (e.g: Suite 343)
city            => [Required] This is the "City" as it appears on the CSR (Customer Service Record) of the losing carrier.
zip             => [Required] This is the "ZIP or Postal Code" as it appears on the CSR (Customer Service Record) of the
                            losing carrier.
state           => [Required] This is the "State or Province" as it appears on the CSR (Customer Service Record) of the losing carrier.
country         => [Required] This is the "Country" as it appears on the CSR (Customer Service Record) of the losing carrier.
providerName    => [Required] The name of your current service provider.
providerAccount => [Required] Your Account with your current service provider.
notes           => - If you would like to include additional information regarding this port, you can use this parameter.
                            

Array
(
    [status] => success
    [port] => ##### (Number ID of the created record)
)
                            

portid      => [Required] ID of the port previously created.
file        => [Required] Base 64 code of the file to be attached
                            

Array
(
    [status] => success
    [attachment] => ##### (Number ID of the created record)
)
                            

No Parameter                            

Array
(
    [status] => success
    [list_status] => Array(
        "status_code" => "Status Description",
    )
)
                            

portid         => [Required] ID of the port previously created.
portStatus     => Status code to filtering Ports. Example: precessing. (You can use the values returned by the method getLNPListStatus)
startDate      => Start Date for filtering Ports. (Example: '2014-03-30')
endDate        => End Date for filtering Ports. (Example: '2014-03-30')                            

Array
(
    [status] => success
    [list] => Array(
                Array (
                    [portid] => "0000",
                    [numbers] => "####,###",
                    [foc_date] => "2019-01-08",
                    [status] => "processing"
                ),
                Array (
                    [portid] => "1111",
                    [numbers] => "####",
                    [foc_date] => false,
                    [status] => "processing"
                )
            )
)
                            

portid         => [Required] ID of the port previously created.                            

Array
(
    [status] => success
    [post_status] => "pending_approval"
    [post_status_description] => "Pending Approval"

)
                            

portid         => [Required] ID of the port previously created.                            

Array (
    [status] => success
    [id] => 0000,
    [numbers] => Array (
                    Array (
                        [did] => "###########",
                        [rateCenter] => "COVINA",
                        [state] => "CA"
                    ),
            ),
    [isPartial] => "0",
    [locationType] => "0",
    [isMobile] => "0",
    [mobileInfo] => "",
    [tfType] => "0",
    [portType] => "1",
    [btn] => "",
    [services] => "",
    [statementName] => "",
    [firstName] => "",
    [lastName] => "",
    [address1] => "Covina 12 St.",
    [address2] => "",
    [city] => "CA",
    [zip] => "",
    [state] => "CA",
    [country] => "US",
    [providerName] => "",
    [providerAccount] => "",
    [customer_notes] => "",
    [notes] => Array (
            Array (
                [note] => "You have submitted a new LNP Order. Current status is Pending Approval. A member of our staff will review your submission and update status accordingly.",
                [date] => "2019-02-25",
                [time] => "15:05:11"
            ),
        ),
    [post_status] => "pending_approval"
    [post_status_description] => "Pending Approval"
    [date] => "2019-02-25 15:05:11",
    [focDate] => "",
    [attachments] => Array (
        Array (
            [id] => "0000",
            [description] => "Signed Invoice",
            [type] => "pdf",
            [bytes] => "151600"
        ),
    )
)
                            

portid         => [Required] ID of the port previously created.                            

Array
(
    [status] => success
    [list] => Array(
                Array (
                    [note] => "You have submitted a new LNP Order. Current status is Pending Approval. A member of our staff will review your submission and update status accordingly.",
                    [date] => "2019-02-25",
                    [time] => "15:05:11"
                )
            )

)
                            

portid         => [Required] ID of the port previously created.
attachid         => [Required] ID of the invoice (attachment) previously uploaded.                            

Array
(
    [status] => success
    [type] => "pdf",
    [size] => "151600",
    [base64] => "Base64 Code"
)
                            

portid         => [Required] ID of the port previously created.                            

Array
(
    [status] => success
    [list] => Array(
                Array (
                    [attachid] => "000",
                    [type] => "pdf",
                    [size] => "151600"
                )
            )
)
                            

digits                        => [Required] Digits used to create the voicemail (Example: 01) Minimum 1 digit, maximum 10 digits
name                          => [Required] Name for the Mailbox
password                      => [Required] Password for the Mailbox
skip_password                 => [Required] True if Skipping Password (Boolean: 1/0)
email                         =>            Client's e-mail address for receiving Messages
attach_message                => [Required] Yes for Attaching WAV files to Message (Values: 'yes'/'no')
delete_message                => [Required] Yes for Deleting Messages (Values: 'yes'/'no')
say_time                      => [Required] Yes for Saying Time Stamp (Values: 'yes'/'no')
timezone                      => [Required] Time Zone for Mailbox (Values from getTimeZones)
say_callerid                  => [Required] Yes for Saying the Caller ID (Values: 'yes'/'no')
play_instructions             => [Required] Code for Play Instructions Setting (Values from getPlayInstructions)
language                      => [Required] Code for Language (Values from getLanguages)
client                        => [Optional] ID for a specific Reseller Client (Example: 561115)
transcription                 => Voicemail Transcription
transcription_locale          => Transcription locale code (values from getLocales)
email_attachment_format       => Code for Email Attachment format (Values from getVoicemailAttachmentFormats)
unavailable_message_recording => Recording for the Unavailable Message (values from getRecordings)


                            

Array
(
    [status] => success
)
                            

mailbox     => [Required] ID for a specific Mailbox (Example: 1001)
folder      => Name for specific Folder (Required if message id is passed, Example: 'INBOX', values from: getVoicemailFolders)
message_num => ID for specific Voicemail Message (Required if folder is passed, Example: 1)                            

Array
(
    [status] => success
)
                            

member     => [Required] ID for a specific Member (Example: 101)
conference => ID for a specific Conference (Example: 3829)
                            

Array
(
    [status] => success
)
                            

mailbox           => [Required] ID for a specific Mailbox (Example: 1001)

Array
(
    [status] => success
)
                            

play_instructions  => Code for a specific Play Instructions setting (Example: 'u')

Array
(
    [status] => success
    [play_instructions] => Array
        (
            [0] => Array
                (
                    [value] => u
                    [description] => Yes
                )
        )
)
                            

timezone   => Code for a specific Time Zone (Example: 'America/Buenos_Aires')

Array
(
    [status] => success
    [timezones] => Array
        (
            [0] => Array
                (
                    [value] => America/Buenos_Aires
                    [description] => America/Buenos Aires
                )
        )
)
                            

mailbox    => ID for specific Mailbox (Example: 1001)
client     => [Optional] ID for a specific Reseller Client (Example: 561115)                            

Array
(
    [status] => success
    [voicemails] => Array
        (
            [0] => Array
                (
                    [mailbox] => 1001
                    [name] => VoIP
                    [password] => 1234
                    [skip_password] => 1
                    [email] => john.doe@my-domain.com
                    [attach_message] => yes
                    [delete_message] => no
                    [say_time] => yes
                    [timezone] => America/Chicago
                    [say_callerid] => yes
                    [play_instructions] => su
                    [language] => en
                    [email_attachment_format] => wav49
                    [unavailable_message_recording]=> 19183
                    [new] => 3
                    [urgent] => 2
                    [transcribe] => 1
                    [transcription_locale] => en-US
                )
        )
)
                            

folder    =>  Folder Name (Example: 'INBOX')
mailbox    => ID for specific Mailbox (Example: 1001)

Array
(
    [status] => success
    [folders] => Array
        (
            [0] => Array
                (
                    [value] => INBOX
                    [description] => INBOX
                )
        )
)
                            

mailbox    => [Required] ID for specific Mailbox (Example: 1001)
folder     => [Required] Name for specific Folder (Example: 'INBOX', values from: getVoicemailFolders)
message_num=> [Required] ID for specific Voicemail Message (Example: 1)
format     =>            File format. Default value is mp3. Values: mp3, wav, wav49, gsm.                            

Array
(
    [status] => success
    [message] => Array
        (
            [0] => Array
                (
                    [mailbox]    => 1001
                    [folder]     => INBOX
                    [message_num] => 1
                    [data]   => UklGRqTEAQBXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YYDEA....
                )
        )
)
                            

mailbox   => [Required] ID for specific Mailbox (Example: 1001)
folder    =>            Name for specific Folder (Example: 'INBOX', values from: getVoicemailFolders)
date_from =>            Start Date for Filtering Voicemail Messages (Example: '2016-01-30')
date_to   =>            End Date for Filtering Voicemail Messages (Example: '2016-01-30')                            

Array
(
    [status] => success
    [messages] => Array
        (
            [0] => Array
                (
                    [mailbox] => 1001
                    [folder] => INBOX
                    [message_num] => 1
                    [date] => 2016-01-30
                    [callerid] => 5551234567
                    [duration] => 00:00:06
                    [urgent] => yes
                    [listened] => no

                )
        )
)
                            

vpri   => [Required] ID for specific vpri (Example: 1001)                            

Array
(
    [status] => success
    [vpri] => Array
        (
            [0] => Array
                (
                    [vpri] => 100112
                    [name] => main vpri
                    [note] => Important notes
                    [channels] => 1
                    [monthly_fee] => 0.2
                    [next_billing] => 2022-08-15
                    [burst_enabled] => 1
                    [burst_max_channels] => 2
                    [burst_percentage_charge] => 1

                )
        )
)
                            

mailbox     => [Required] ID for specific Mailbox (Example: 1001)
folder      => [Required] Name for specific Folder (Example: 'INBOX', values from: getVoicemailFolders)
message_num => [Required] ID for specific Voicemail Message (Example: 1)
listened    => [Required] Code for mark voicemail as listened or not-listened (Values: 'yes'/'no')                            

Array
(
    [status] => success
)
                            

mailbox     => [Required] ID for specific Mailbox (Example: 1001)
folder      => [Required] Name for specific Folder (Example: 'INBOX', values from: getVoicemailFolders)
message_num => [Required] ID for specific Voicemail Message (Example: 1)
urgent      => [Required] Code for mark voicemail as urgent or not-urgent (Values: 'yes'/'no')                            

Array
(
    [status] => success
)
                            

mailbox     => [Required] ID for specific Mailbox (Example: 1001)
folder      => [Required] Name for specific Folder (Example: 'INBOX', values from: getVoicemailFolders)
message_num => [Required] ID for specific Voicemail Message (Example: 1)
new_folder  => [Required] Destination Folder (Example: 'Urgent', values from: getVoicemailFolders)                            

Array
(
    [status] => success
)
                            

mailbox      => [Required] ID for specific Mailbox (Example: 1001)
folder       => [Required] Name for specific Folder (Example: 'INBOX', values from: getVoicemailFolders)
message_num  => [Required] ID for specific Voicemail Message (Example: 1)
email_address=> [Required] Destination Email address (Example: john.doe@my-domain.com)                            

Array
(
    [status] => success
)
                            

mailbox                       => [Required] ID for a specific Mailbox (Example: 1001)
name                          => [Required] Name for the Mailbox
password                      => [Required] Password for the Mailbox
skip_password                 => [Required] True if Skipping Password (Boolean: 1/0)
email                         =>            Client's e-mail address for receiving Messages
attach_message                => [Required] Yes for Attaching WAV files to Message (Values: 'yes'/'no')
delete_message                => [Required] Yes for Deleting Messages (Values: 'yes'/'no')
say_time                      => [Required] Yes for Saying Time Stamp (Values: 'yes'/'no')
timezone                      => [Required] Time Zone for Mailbox (Values from getTimeZones)
say_callerid                  => [Required] Yes for Saying the Caller ID (Values: 'yes'/'no')
play_instructions             => [Required] Code for Play Instructions Setting (Values from getPlayInstructions)
language                      => [Required] Code for Language (Values from getLanguages)
client                        => ID for a specific Reseller Client ID (Example: 54374)
transcription                 => Voicemail Transcription
transcription_locale          => Transcription locale code (values from getLocales)
email_attachment_format       => Code for Email Attachment format (Values from getVoicemailAttachmentFormats)
unavailable_message_recording => Recording for the Unavailable Message (values from getRecordings)


                            

Array
(
    [status] => success
)
                            

<?
class VoIPms{
    /*******************************************\
     *  VoIPms - API Credentials
    \*******************************************/
    var $api_username   = 'john.doe@mydomain.com';
    var $api_password   = 'johnspassword';



    /*******************************************\
     *  VoIPms - SoapClient / SoapCall
    \*******************************************/
    var $soap_client;
    function soapClient(){
        $this->soap_client = new SoapClient(null, array(
                'location'      => "https://voip.ms/api/v1/server.php",
                'uri'           => "urn://voip.ms",
                'soap_version'  => SOAP_1_2,
                'trace'         => 1
            )
        );
    }

    function soapCall($function, $params){
        if(!$this->soap_client){$this->soapClient();}
        try { return $this->soap_client->__soapCall($function, $params);}
        catch (SoapFault $e) { trigger_error("SOAP Fault: [{$e->faultcode}] {$e->faultstring}", E_USER_ERROR); }
    }



    /*******************************************\
     *  VoIPms - API Functions
    \*******************************************/

    function getServersInfo($server_pop){
        $function = "getServersInfo";
        $params = array(
            "params" => array(
                "api_username"  => $this->api_username,
                "api_password"  => $this->api_password,
                "server_pop"    => $server_pop
            )
        );
        return $this->soapCall($function,$params);
    }
}
?>
                            

<?
require_once("class.voipms.php");
$voipms = new VoIPms();

echo "<pre>";


echo "
Display Specific Server
=======================
";
$response = $voipms->getServersInfo(1);
print_r($response);


echo "
Display All Servers
===================
";
$response = $voipms->getServersInfo();
print_r($response);


echo "</pre>";
?>
                            

<?
$ch = curl_init();

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true );

curl_setopt($ch, CURLOPT_URL,
"https://voip.ms/api/v1/rest.php?api_username=john@domain.com&api_password=password&method=getServersInfo&server_pop=1");
$result1 = curl_exec($ch);

curl_setopt($ch, CURLOPT_URL,
"https://voip.ms/api/v1/rest.php?api_username=john@domain.com&api_password=password&method=getServersInfo");
$result2 = curl_exec($ch);

curl_close($ch);

/* Convert JSON to Array */
$data1=json_decode($result1,true);
$data2=json_decode($result2,true);


echo "<pre>";

echo "
Display Specific Server
=======================
";
print_r($data1);


echo "
Display All Servers
===================
";
print_r($data2);

echo "</pre>";
?>
                            

<?
$postfields = array(
    'api_username'=>'john@domain.com',
    'api_password'=>'password',
    'method'=>'getServersInfo',
    'server_pop'=>'1'
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt($ch, CURLOPT_POST, true );
curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);
curl_setopt($ch, CURLOPT_URL, "https://voip.ms/api/v1/rest.php");
$result = curl_exec($ch);
curl_close($ch);

$data=json_decode($result,true);

echo "<pre>";
print_r($data);
echo "</pre>";
?>