Cloud SMS Api

SMS API service helps you benefit from WEB2SMS advantages without using a third interface. The existing company interface can be easily connected to Apifon's SMSC via HTTP connection. All features that are covered by the WEB2SMS service are also available for API service.
  • Use customized sender IDs
  • Get your balance via different format types (json, xml, html, csv).
  • Get delivery reports via different format types (json, xml, html, csv).
  • Delivery reports supported also with Callback URL.
  • Schedule your sms messages.
  • Cancel your scheduled sms messages
  • Number lookup, with network portability support.
Through Apifon's API gateway, you can embed a script at your desktop or web application (i.e. crm, erp, eshop) using a GET/POST method at our SMS center.This is a quick overview of how Apifon's API is working.
Apifon OVER HTTP
Apifon API: Account Balance
In order to get your account balance you have to call the following syntax:
 http://smsc.apifon.com/balance/?apikey=MY_KEY&export=EXPORT_FORMAT

  • While authorized, the above link will return your account balance.
  • 5 incorrect attempts, will block your IP address temporarily (for 5 mins).
Parameters Description
apikey[Required] is your ID in order to connect via your account. You can get one while signing up.
export[Optional] the response can be accordently to the desired format ('XML', 'jSON' or 'Html'). Default is 'Html'.
Apifon API: Send SMS
In order to send a message you have to call the following syntax:
http://smsc.apifon.com/send/?apikey=MY_KEY&from=SENDER_ID&
to=RECIPIENTS&text=YOUR_TEXT&date=FUTURE_DATE&export=EXPORT_FORMAT&
parameters=PARAMETERS

  • While authorized, the above link will send a message to recipients.
  • Recipient's phone number must be at international format (i.e. for UK: 44 1234567890).
  • The recipient will receive an sms with, title='SENDER_ID' and message='YOUR_TEXT'.
  • The return of the call reports the message ID, send date, recipients details, costs etc. Save the message ID, to keep report status.
Parameters Description
apikey[Required] is your ID in order to connect via your account. You can get one while signing up.
from[Required] is what recipients will read at the message title.
to[Required] recipients numbers at international format. Massive recipients supported separated by comma ',' (i.e. to=306900000000,306911111111).
text [Optional] is your message and can be up to 160 characters (unicode) costing for 1 sms, or may be bigger costing for more.
date[Optional] is your desired date and time to schedule your sms (default is present time). The date format can be like Year-month-day Hour:minute:second (i.e. 2018-11-03 16:30:20).
export[Optional] the respose can be accorded to the desired format ('XML', 'jSON' or 'Html'). Default is 'Html'.
parameters[Optional] use it to send extra parameters to help you group or sort better while reading delivery reports.
Apifon API: Delivery Reports
In order to get a report status of sent messages you have to call the following syntax:
http://smsc.apifon.com/tracking/?apikey=MY_KEY&msgID=MESSAGE_ID&
recipientID=RECIPIENT_ID&export=EXPORT_FORMAT

  • While authorized, the above link will return you the response whether the message was deleted or not. (Also credit your account back).
Parameters Description
apikey[Required] is your ID in order to connect via your account. You can get one while signing up.
msgID[Required] is about the message ID you desire to get report status.
recipientID[Optional] use single or massive (separated by comma ',' ) to search specific recipients. If empty it will return all status of the recipients related to the message ID.
export[Optional] the response can be accorded to the desired format ('CSV', 'XML', 'jSON' or 'Html'). Default is 'Html'.
Apifon API: Remove scheduled messages
In order to cancel your scheduled sms messages you have to call the following syntax:
http://smsc.apifon.com/remove/?apikey=MY_KEY&msgID=MESSAGE_ID&
export=EXPORT_FORMAT

  • While authorized, the above link will return you the report status code (final or intermediate).
Parameters Description
apikey[Required] is your ID in order to connect via your account. You can get one while signing up.
msgID[Required] is about the message ID you desire to cancel.
export[Optional] the response can be accorded to the desired format ('CSV', 'XML', 'jSON' or 'Html'). Default is 'Html'.
For more information contact us at info@apifon.com