Callback URL
A “callback URL” is the web address an API needs to send information for use by a different web site.
You will need to have a system that can accept http and https requests from our server in order to use the callback_url and status_url. This has been tested with JAVA and .Net applications.
How to Use
You will need to configure some elements of the system to use the callback_url or status_url. You must first have a valid account which will have a user name (e-mail ID) and password. With access to the solution you will need to create at least one organization, division and group. At the group level you can define the callback URL which should point back to your system.
IP Whitelisting
You will need to whitelist the following IP addresses during configuration of callback in your system:
- Production/Live: 52.202.25.134, 34.193.0.200 and 35.164.173.186
- Staging/Testing: 3.226.203.173 and 54.149.28.201
Code Examples:
C#
StringBuilder str = new StringBuilder(); str.Append("==========CallBack Message Start==========="); str.Append(Environment.NewLine); str.Append("Title = " + Request["title"]); str.Append(Environment.NewLine); str.Append("Code = " + Request["code"]); str.Append(Environment.NewLine); str.Append("ShortCode = " + Request["shortcode"]); str.Append(Environment.NewLine); str.Append("Message = " + Request["message"]); str.Append(Environment.NewLine); str.Append("Phone = " + Request["phone"]); str.Append(Environment.NewLine); str.Append("Carrier = " + Request["carrier"]); str.Append(Environment.NewLine); str.Append("Keyword = " + Request["keyword"]); str.Append(Environment.NewLine); str.Append("Group = " + Request["group"]); str.Append(Environment.NewLine); str.Append("Note = " + Request["note"]); str.Append(Environment.NewLine); str.Append("UniqueID = " + Request["UniqueID"]); str.Append(Environment.NewLine); //default_keyword is orgcode of a organization str.Append("Default_Keyword = " + Request["default_keyword"]); str.Append(Environment.NewLine); str.Append("transactionticket = " + Request["transactionticket"]); str.Append(Environment.NewLine); str.Append("==========CallBack Message End==========="); str.Append(Environment.NewLine);
Java
StringBuilder str = new StringBuilder(); str.append("==========CallBack Message Start==========="); str.append("\n"); str.append(("Title = " + request.getAttribute(title)); str.append("\n"); str.append(("Code = " + request.getAttribute(code)); str.append("\n"); str.append(("ShortCode = " + request.getAttribute(shortcode)); str.append("\n"); str.append(("Message = " + request.getAttribute(message)); str.append("\n"); str.append(("Phone = " + request.getAttribute(phone)); str.append("\n"); str.append(("Carrier = " + request.getAttribute(carrier)); str.append("\n"); str.append(("Keyword = " + request.getAttribute(keyword)); str.append("\n"); str.append(("Group = " + request.getAttribute(group)); str.append("\n"); str.append(("Note = " + request.getAttribute(note)); str.append("\n"); str.append(("UniqueID = " + request.getAttribute(UniqueID)); str.append("\n"); //default_keyword is orgcode of a organization str.append(("Default_Keyword = " + request.getAttribute(default_keyword)); str.append("\n"); str.append(("transactionticket= " + request.getAttribute("transactionticket")); str.append("\n"); str.append("==========CallBack Message End===========");
Diagram to show the function of callback URL Functionality