| Arguments |
Value
Examples |
Notes |
| user_name |
testdriver |
Account unique identifier. |
| password |
12345 |
Account password |
| receiver_name* |
John Smith |
If a receiver_name is provided, the notification system will
announce this person's name at the start of the call.
For this example, the call will announce "This call is for John Smith" |
| phone_number* |
8005551515
2125553331 |
Valid 10-digit phone
number. The notification system will attempt to establish a connection with phone_number. |
| phone_extension |
1234 |
You must select a transfer_type when you
set the the phone_extension |
| transfer_type |
No Transfer
Automated System
Live |
Use phone_transfer_type when
your call
needs to be transfered
by a live person or automated system to
an extension. |
| notification_dt* |
03/16/2004 07:00am
07/28/2003 2:45:00pm
07/28/2003 11:30:00am
now
now8 (now plus 8 minute
offset) |
Valid notification date/time. You can add a time offset to the end of the time expression. When notification_dt is set to "now", the notification will trigger seconds after the notification is submitted. |
| timezone_id |
2 (Hawaii), 3 (Alaska), 4 (Pacific),
10 (Mountain), 15 (Arizona), 20 (Central),
35 (Eastern), 40 (Indiana), 50 (Atlantic),
55 (Virgin Islands)
|
A valid Time Zone ID. If timezone_id is not submitted, the
time zone of the submitted phone_number's areacode will be
used to determine the time zone. For Eastern Timezone, you would set &timezone_id=35 |
| repeat_type |
Daily, Weekly, Weekdays, Weekends,
Monthly |
Use repeat_type to create recurring
calls automatically. repeat_type is
intended
to be used with added_days. |
| added_days |
7 |
Example:
&repeat_type=daily&added_days=14 means
daily for 2 weeks.
&repeat_type=weekly&added_days=56
means weekly for 2 months.
|
| tracking_id |
acme125615243 |
This alphanumeric value should be unique to distinquish it
from other notifications in database. This number is used to identify a notification
you want to monitor, update, or delete at a later time. This field is not required. |
| email_to |
info@bsmartcommunications.com |
A valid email address. When email_enabled is set to
"yes", The notification system will send an email to the email_to email address.
|
| email_from |
techsupport@bsmartcommunications.com |
A valid email
address. The notification system will present the value of the email_from as the email "from" address.
|
| email_subject |
Notification API |
The subject of an email notification.
|
| email_body |
"Hello, I would like more information about the i Ping Notification API." |
The body of an email notification.
|
| msg_name_intro |
myIntro |
The audio file will be played in the intro section of the call flow. |
| msg_name_intro_enabled |
on or off
|
Set this feature "off" if you do not want the iPing system to play the intro message
provided in the msg_name_intro parameter. If the msg_name_intro_enabled parameter is not provided to the PutNotification
method, the default setting is "on" by default.
|
| msg_name_body |
myContentBody |
The audio file will be played in the content section of the call flow. |
| msg_text_body |
"Please attend the sales and marketing meeting." |
The msg_text_body will be played in the
content
section of the call flow. If msg_name_body contains a value then msg_text_body will
NOT be played. msg_text_body length is a maximum of 500 characters. |
| tts_engine |
mary (microsoft),
mike (microsoft)
rick, mara |
The available text-2-speech (TTS) engines
|
| retry_time |
5
|
When a notification attempt has failed to reach its unavailable intended receiver, the retry_time is the amount of time in minutes to wait
before re-attempting to send the notification again.
This element is expected to be used in conjunction with the retry_count element.
The retry_time has a constraint or 3 to 60 minutes.
|
| retry_count |
3
|
When a notification attempt has failed to reach its unavailable intended receiver,
The retry_count is the number of times to retry a notification before stopping attempts.
This element is expected to be used in conjunction with the retry_time element.
The retry_count has a constraint of 0 to 5 retry attempts.
|
| detect_live_enabled |
on or off
|
When detect_live_enabled is "on" the person that receives the call will be asked,
"Please press any key to continue." If the call receiver presses a key on the
phone dial pad, the iPing system will know for sure that a live person has
received the phone call and not an answering machine. Once your phone calls are
delivered you can see if a live person or an answering machine received the
phone call by viewing your account's PAST PINGs .
If detect_live_enabled is not set, "off" is the default value.
|
| answering_machine_enabled |
on or off
|
Set this feature "on" if you want the iPing system to leave your message
content on the call receiver's answering machine, if a live person does not answer
the call.
|
| detect_ans_machine_enabled |
on or off
|
When this feature is set to "on", the iPing system will detect an answering machine and wait until
the answering machine's greeting is finished before the system starts to play audio to the call receiver.
|
| play_receiver_name |
on or off
|
When play_receiver_name is set to "on", the system will announce the call receiver's name.
play_receiver_name is intended to be used only when receiver_name is set to a value.
|
| repeat_content_count |
2
|
Set repeat_content_count =
3 if you want the iPing system
to permit the receiver of the call to repeat the message 3 times.
The message is provided in the msg_name_body or
msg_text_body parameters. 2 is the Default value for this
parameter. Set repeat_content_count=
1
so that the receiver of
the call will hear the message only once.
|
| transfer_enabled |
on or off
|
Setting transfer_enabled enables your call receiver to redirect their call to
the transfer_phone phone number. The call receiver has to press "1" while
the msg_name_body message is playing. It is important to instruct the call receiver that she should press "1" to transfer.
For example, when recording your msg_name_body audio file, you should say something like
"To speak to a company representative press "1" at any time during this announcement message"
|
| transfer_phone |
2125551234
|
The phone number to transfer to.
|
| transfer_extension |
1234567
|
The extension to the transfer_phone phone number.
|
| ani_enabled |
on or off
|
Set ani_enabled to "on" if you would like your company's
caller id to show in the call receiver's cell phone or caller id display box.
|
| ani_phone |
2125551234
|
|
| voicemail_enabled |
on or off
|
Set voicemail_enabled to "on" so that a call receiver can leave a voicemail in your account's voicemail box.
The call receiver will be prompted to leave a voice message directly after the msg_name_body section (content) is played.
If the voicemail_enabled parameter is not provided to the PutNotification
method, the default setting is "off" by default.
|
|
|
|
* 
