Developers & API: Event Notifications

Subscribe

When a new subscription is successfully completed via the various different subscription methods, a HTTP Post is sent to your Event Notification URL with the subscription information. Please email support at optit.com to setup your Event Notification URL.

HTTP Method:

POST

Parameters:

• event_type - value will equal "1" for Subscribe
• phone - mobile phone number of the member with country code - 1 for U.S. phone numbers
• member_id - the member_id of a member
• keyword_id - the keyword_id that the member subscribed.
• keyword - the name of the keyword.
• short_code - the short code of the keyword.
• signup_date - yyyymmddhhmmss
• first_name - first name of the member
• last_name - last name of the member
• email_address - email address of the member
• zip - zip code or postal code of the member
• gender - gender of the member. Values: [male, female]
• request_id - unique identifier of the request.

Unsubscribe

When a member unsubscribes from a keyword via the various different unsubscribe methods, a HTTP Post is sent to your Event Notification URL with the unsubscribe information. Please email support at optit.com to setup your Event Notification URL.

HTTP Method:

POST

Parameters:

• event_type - value will equal "2" for Unsubscribe.
• phone - mobile phone number of the member with country code - 1 for U.S. phone numbers
• member_id - the member_id of a member
• keyword_id - the keyword_id that the member subscribed.
• keyword - the name of the keyword.
• short_code - the short code of the keyword.
• unsubscribe_date - yyyymmddhhmmss
• request_id - unique identifier of the request.

SendMessage

When sending a message through any of the Send Message methods, a synchronous response is returned giving you a request_id for that SendMessage method call. The process of actually sending the message is an asynchronous process and when the process has completed meaning the message has been successfully sent to the mobile carrier, a HTTP Post(s) is sent to your Event Notification URL with the response code for this message. For messages sent to multiple individual phone numbers, keywords or interests, you will receive an event notification for each one. Please email support at optit.com to setup your Event Notification URL.

Depending on the Send Message method that is used, you will receive the following responses:

1. Send a text message to an individual member
   If the keyword is valid, we will send an Event for each phone number that was submitted with the original request along with the request_id that was returned.
2. Send a text message to a keyword
   If the keyword is valid, we sent an Event for each keyword that was submitted with the original request along with the request_id that was returned.
3. Send a text message to an interest
   If the interest is valid, we sent an Event for each interest that was submitted with the original request along with the request_id that was returned.

HTTP Method:

POST

Parameters:

• event_type - value will equal "3" for Send Message.
• request_id - the unique identifier that is returned when making any of the Send Message method calls
• phone - mobile phone number that the message was sent. (Only applies to Send a text message to a individual member)
• keyword_id - the keyword_id that the message was sent. (Only applies to Send a text message to an individual member and Send a text message to a keyword)
• interest_id - the interest_id that the message was sent. (Only applies to Send a text message to an interest)
• response_code - the response code of message. (Values below)
• response_desc - the description of the response code of message. (Values below)

Response Codes:

response_code	response_desc	Description
1000	Success	Message was successfully sent.
2000	Error - Internal Error	The was a generic error processing the Send Message request.
2100	Error - Keyword Not Found	The keyword_id that was supplied with the request is not valid or valid for this user.
2200	Error - Interest Not Found	The interest_id that was supplied with the request is not valid or valid for this user.
3100	Error - Invalid Mobile Number	The phone number is invalid or is not subscribed for this keyword.
3200	Error - Mobile Number Unsubscribed	The phone number is unsubscribed from this keyword.
3300	Error - Mobile Number Stopped	The mobile phone user has requested to stop receiving messages from this keyword.
3400	Error - Mobile Number Blocked	This phone number has been blocked by with either the mobile phone user or mobile phone carrier.