CDYNE PostBackURL for Phone Notify! and SMS Notify! APIs

PostBackURLs allow Phone Notify! and SMS Notify! API customers to instantly know when an end user responds to a message or notification.  When a notification is sent out, CDYNE servers send a message back to the company’s designated PostBackURL noting the message has been sent.  When an end user responds, the results are also posted to the PostbackURL.

PostbackURL Assignment

A PostBackURL can be assigned to SMS Notify! and/or Phone Notify! request by using the advanced methods.  The advanced method for each service will have a property called StatusPostBackURL which is set with a link to the webpage created to handle a post back.  In addition, for incoming calls and text messages to a dedicated line that are not responses to previous messages, a StatusPostBackURL can be assigned directly to a customer’s DID (Phone number) allowing all end user generated traffic to go directly to the post back page.  This can be set up by contacting an account representative at 1-800-984-3710, sending an email inquiry or initiating a chat.

Using a PostBackURL with Phone Notify!

PostBackURLs can be very useful with the Phone Notify! API. It prevents the need to use the GetQueueIDStatus or GetMultipleQueueIDStatus methods. When using these methods, the customer’s server calls the methods multiple times as the customer would not know when the call has finished. With a PostBackURL in place, this allows the customer to have a webpage that will accept a POST from the Phone Notify! API when a call is placed, the call status has changed, the call is finished, or when a call is received (if using an Incoming DID).

When sending notifications, the PostBackURL can be set by using either the ~StatusChangePostURL()~ script command at the beginning of the call script (especially when using NotifyPhoneBasic), or the StatusChangePostURL parameter in the NotifyPhoneAdvanced operation. When using an Incoming DID with the Phone Notify! API, a CDYNE account representative can assign a PostBackURL to that Incoming DID assigned to the customer’s account.

All available operations for the Phone Notify! API can be found here: http://ws.cdyne.com/NotifyWS/PhoneNotify.asmx, and advanced scripting commands can be found here: http://wiki.cdyne.com/index.php/Phone_Notify!_TextToSay_Advanced_Commands

Using a PostBackURL with SMS Notify!

With SMS Notify! There are several advantages to setting a StatusPostBackURL.  When a user responds to a message, CDYNE will immediately notify the SMS Notify! API customer via a post to the StatusPostBackURL. This eliminates the need for the customer to constantly query CDYNE servers for responses.

SMS Notify! API customers will receive a sent post with a PostBackUrl set in the request. The sent Post simply states the status of the SMS message at that time, and whether or not there were any minor errors in the request.  When this request is properly formatted, then the SMS message will be queued in the CDYNE system awaiting processing by the carrier.

If the recipient responds after the message has been sent, CDYNE will post the response post as well. The response post contains the recipient’s message and can be handled however your business model demands (i.e. storing the information in a database, or responding with another message).

The StatusPostBackURL can also be used with a dedicated line. A CDYNE representative can assign a customer’s designated StatusPostBackURL to their DID. Then, any incoming traffic to that number will result in a post to the designated StatusPostBackURL.  This is the preferred way to accommodate business models that want to make use of mobile originated messages.

There are two methods in SMS Notify! that makes use of a StatusPostBackUrl: http://sms2.cdyne.com/sms.svc/help/operations/AdvancedSMSsendhttp://sms2.cdyne.com/sms.svc/help/operations/SimpleSMSsendWithPostback.

Leave a reply