API REMINDER

From Xminder
Jump to: navigation, search

Xminder API REMINDER Documentation

Contents


SMS Reminder


This API calls the quickEvent method of the Calendar module to create an event in the calendar, using at least the obligatory parameters and sets an SMS reminder for the event.
Parameter Description Example
key

The access key to make a request to a module.

This key is provided by Xminder's administrators and it must NOT be published.

The default value for this parameter is NULL.

5d952f8293148969d4c87518e5524641
Summary Event summary. Group Reminder
To The recipients' phone numbers.
Numbers are separated by "," (comma symbol).
At least one phone number should appear in the URL.
0000000000
0000000000,1111111111
Start Event start date/time.

Form: yyyy-mm-dd hh:mm:ss or yyyy-mm-dd hh.mm or yyyy/mm/dd.

2012-08-07 14:00
2012-08-07 14.00
2012-08-07
2012/08/07
End Event end date/time. If this parameter is not present, the event will end one hour after it has started. the same form as Start
ReminderStart Set the reminder start date/time. If this parameter is not present, the reminder will be sent 10 minutes before the start of the event. the same form as Start
ReminderText Set the reminder's text message. If this parameter is not present, an automatically generated message will be sent. testing... testing...
Observations:
  1. The parameters key, To and Start are required parameters.
  2. Parameters' names for this method are case sensitive. This means that Start (that is a correct parameter's name) is different than start.
  3. The values of the parameters key, To and Start from the table above (column Example) are not valid.
  4. This method will not send SMS reminders if your office doesn't have sufficient funds. The user must check his credit before using the method.
  5. If the parameter ReminderText must include symbols like "&" (ampersand), "#" (pound sign), "+" (plus sign) or other special characters:
    • if the URL will be used from the browser's address bar these characters should be encoded (using their code points in hexadecimal) like so: # = %23, & = %26, + = %2B etc.
    • if the URL will be used from PHP, it should be used the urlencode function first.


Simple Example


URL: https://api.xminder.com/calendar.quickEvent?key=5d955f8293148969d4b82518e5524646&To=0000000000,1111111111,22www22222&Start=2012-08-10 15:40&End=2012-08-10 17:40&Summary=Group SMS Reminder&ReminderStart=2012-08-10 12:40&ReminderText=Reminder from Xminder

Success (the id received in the response is used in the Reminder Status Verification method):
<response>
  <success>true</success>
  <id>74417d7ffh85c8ad03a5edfh6a9bcf2a</id>
  <event>
    <dtstart tzid="EST5EDT" tzname="(UTC-05:00) Eastern Time (US & Canada)">August 10, 2012, 03:40 PM</dtstart>
    <dtend tzid="EST5EDT" tzname="(UTC-05:00) Eastern Time (US & Canada)">August 10, 2012, 05:40 PM</dtend>
    <reminders>
      <reminder type="sms">
        <to>0000000000</to>
        <dtstart tzid="EST5EDT" tzname="(UTC-05:00) Eastern Time (US & Canada)">August 10, 2012, 12:40 PM</dtstart>
      </reminder>
      <reminder type="sms">
        <to>1111111111</to>
        <dtstart tzid="EST5EDT" tzname="(UTC-05:00) Eastern Time (US & Canada)">August 10, 2012, 12:40 PM</dtstart>
      </reminder>
      <reminder type="sms">
        <to>22www22222</to>
        <dtstart tzid="EST5EDT" tzname="(UTC-05:00) Eastern Time (US & Canada)">August 10, 2012, 12:40 PM</dtstart>
      </reminder>
    </reminders>
  </event>
</response>


Error:

<response>
    <success>false</success>
    <message>error's text</message>
    <error>E_SOMETHING</error>
</response>



Email Reminder


This API calls the quickEvent method of the Calendar module to create an event in the calendar, using at least the obligatory parameters and sets an email reminder for the event.
Parameter Description Example
key

The access key to make a request to a module.

This key is provided by Xminder's administrators and it must NOT be published.

The default value for this parameter is NULL.

5d952f8293148969d4c87518e5524641
Summary Event summary. Group Reminder
To The recipients' email addresses.
Email addresses are separated by "," (comma symbol).
At least one email address should appear in the URL.
email_1@test.com
email_1@test.com,email_2@test.com
Start Event start date/time.

Form: yyyy-mm-dd hh:mm:ss or yyyy-mm-dd hh.mm or yyyy/mm/dd.

2012-08-07 14:00
2012-08-07 14.00
2012-08-07
2012/08/07
End Event end date/time. If this parameter is not present, the event will end one hour after it has started. the same form as Start
ReminderType Type of reminder.

In order to sent email reminders the value of this parameter must be email.

ReminderType=email
ReminderStart Set the reminder start date/time. If this parameter is not present, the reminder will be sent 10 minutes before the start of the event. the same form as Start
ReminderText Set the reminder's text message. If this parameter is not present, an automatically generated message will be sent. testing... testing...
Observations:
  1. The parameters key, To and Start and ReminderType are required parameters.
  2. Parameters' names for this method are case sensitive. This means that Start (that is a correct parameter's name) is different than start.
  3. The values of the parameters key, To and Start from the table above (column Example) are not valid.
  4. If the parameter ReminderType is not present, the type of reminder will be automatically set to sms and the email reminder will not be sent.
  5. If the parameter ReminderText must include symbols like "&" (ampersand), "#" (pound sign), "+" (plus sign) or other special characters:
    • if the URL will be used from the browser's address bar these characters should be encoded (using their code points in hexadecimal) like so: # = %23, & = %26, + = %2B etc.
    • if the URL will be used from PHP, it should be used the urlencode function first.


Simple Example


URL: https://api.xminder.com/calendar.quickEvent?key=5d955f8293148969d4b82518e5524646&To=email_1@test.com,email_2@test.com&Start=2012-08-10 15:40&End=2012-08-10 17:40&Summary=Group Email Reminder&ReminderStart=2012-08-10 12:40&ReminderText=Reminder from Xminder&ReminderType=email

Success (the id received in the response is used in the Reminder Status Verification method):
<response>
  <success>true</success>
  <id>082b43939d481e4bd2c462aa4c5a96d9</id>
  <event>
    <dtstart tzid="EST5EDT" tzname="(UTC-05:00) Eastern Time (US & Canada)">September 4, 2012, 11:00 AM</dtstart>
    <dtend tzid="EST5EDT" tzname="(UTC-05:00) Eastern Time (US & Canada)">September 4, 2012, 12:00 PM</dtend>
    <reminders>
      <reminder type="email">
        <to>email_1@test.com</to>
        <dtstart tzid="EST5EDT" tzname="(UTC-05:00) Eastern Time (US & Canada)">September 4, 2012, 09:37 AM</dtstart>
      </reminder>
      <reminder type="email">
        <to>email_2@test.com</to>
        <dtstart tzid="EST5EDT" tzname="(UTC-05:00) Eastern Time (US & Canada)">September 4, 2012, 09:37 AM</dtstart>
      </reminder>
      </reminders>
  </event>
</response>


Error:

<response>
    <success>false</success>
    <message>error's text</message>
    <error>E_SOMETHING</error>
</response>



Reminder Status Verification


Shows information about a calendar event and about the status of its reminder (reminders) by calling the status method of the Calendar module.
Parameter Description Example
key

The access key to make a request to a module.

This key is provided by Xminder's administrators and it must NOT be published.

The default value for this parameter is NULL.

5d952f8293148969d4c87518e5524641
id The ID that you have previously received in the RESPONSE of the SMS Reminder or Email Reminder methods. 74417d7ffh85c8ad03a5edfh6a9bcf2a
Observations:
  1. The parameters key and id are required parameters.
  2. Parameters' names for this method are case sensitive. This means that id (that is a correct parameter's name) is different than ID.
  3. The values of the parameters from the table above (column Example) are not valid.


Example


URL: https://api.xminder.com/calendar.status?key=5d955f8293148969d4b82518e5524646&id=74417d7ffh85c8ad03a5edfh6a9bcf2a

Success:
<response>
  <success>true</success>
  <event>
    <summary>Group SMS Reminder</summary>
    <description/>
    <dtstart tzid="EST5EDT" tzname="(UTC-05:00) Eastern Time (US & Canada)">August 10, 2012, 03:40 PM</dtstart>
    <dtend tzid="EST5EDT" tzname="(UTC-05:00) Eastern Time (US & Canada)">August 10, 2012, 05:40 PM</dtend>
    <reminders>
      <reminder type="sms">
        <to>0000000000</to>
        <text>Reminder from Xminder</text>
        <status>Sent</status>
        <dtsend tzid="EST5EDT" tzname="(UTC-05:00) Eastern Time (US & Canada)">August 10, 2012, 12:40 PM</dtsend>
      </reminder>
      <reminder type="sms">
        <to>1111111111</to>
        <text>Reminder from Xminder</text>
        <status>Sent</status>
        <dtsend tzid="EST5EDT" tzname="(UTC-05:00) Eastern Time (US & Canada)">August 10, 2012, 12:40 PM</dtsend>
      </reminder>
      <reminder type="sms">
        <to>22www22222</to>
        <text>Reminder from Xminder</text>
        <status>Invalid Cell Phone</status>
        <dtsend tzid="EST5EDT" tzname="(UTC-05:00) Eastern Time (US & Canada)">August 10, 2012, 12:40 PM</dtsend>
      </reminder>
    </reminders>
  </event>
</response>


Error:

<response>
  <success>false</success>
  <error>E_SOMETHING</error>
</response>



Description of the errors


General API errors


General API errors
Code Description
E_CREDIT_EXPIRED Credit expired.
E_DENIED_IP The request is not accepted from the client's IP. Please contact Xminder's administrators.
E_KEY_DISABLED The value of the parameter key used in the request has been disabled. Please contact Xminder's administrators.
E_KEY_EMPTY The parameter key is missing from the request.
E_KEY_INVALID The value of the parameter key is invalid.
E_METHOD_INVALID Request to a module that does not exist in API.
E_NO_CREDIT Insufficient credit.
E_INTERNAL_X Internal error. Please contact Xminder's administrators and give them complete information about the error (E_INTERNAL_143, E_INTERNAL_345 or other).


API REMINDER Errors


API REMINDER errors
Code Description
E_CALENDAR_END_INVALID The value of the parameter End is not a valid time string.
E_CALENDAR_EVENT_DURATION_INVALID The End value cannot be set earlier than the Start value.
E_CALENDAR_EVENT_NOT_FOUND There is no event in the calendar with this id .
E_CALENDAR_EVENT_OUT_OF_DATE The End value cannot be set earlier than the current date/time.
E_CALENDAR_PARAM_ID The parameter id is missing from the request.
E_CALENDAR_PARAM_ID_INVALID The value of the parameter id is empty or is not valid.
E_CALENDAR_REMINDER_DATETIME_EXCEEDED The ReminderStart value cannot be bigger than the End value.
E_CALENDAR_REMINDER_START_INVALID The value of the parameter ReminderStart is not a valid time string.
E_CALENDAR_REMINDER_TO_EMPTY The parameter To is missing from the request.
E_CALENDAR_REMINDER_TYPE_INVALID The value of the parameter ReminderType is not valid. The only accepted values for this field are sms and email.
E_CALENDAR_START The parameter Start is missing from the request.
E_CALENDAR_START_INVALID The value of the parameter Start is not a valid time string.
E_CALENDAR_INTERNAL_X Internal error of the module CALENDAR. Please contact Xminder's administrators and give them complete information about the error (E_CALENDAR_INTERNAL_121, E_CALENDAR_INTERNAL_205 or other).



    ⇑ Top of page ⇐ Home    
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox