Developers & API: Send Message

Send a text message to an individual member

Send a text message to one or many members. A message will only be sent to a member if the member is properly subscribed to the keyword. If you need to send one time messages to a user such as a send-to-phone feature, email support at optit.com to have this funtionality enabled.

URL:

http://api.optitmobile.com/1/sendmessage.{format}

Format:

xml, json

HTTP Method:

POST

Parameters:

• phone - mobile phone number of the member with country code - 1 for U.S. phone numbers. Comma separate for more than one phone number. (Required)  Example: 12225551212,12225551211
• keyword_id - the keyword_id of the keyword the message is coming from and the member is subscribed to. It is the ID attribute in the Keyword entity and can be viewed using the Get Keyword method. (Required)
• title - the title of the message. This does not appear in the text message and is just used in the application as a short description of your message. (Required)
• message - the message being sent to the member. The message must be less than 160 characters including your keyword in the beginning of the message. (Required)
• schedule_date - a text value containing the date and time to schedule this message to be sent in the future in the format YYYYMMDDhhmm. (Optional)

XML Response

<?xml version="1.0" encoding="UTF-8"?>
    <message>
        <request_id>1b856ad4-2403-4600-96bd-8bf0959cbc8a</request_id>
    </message>

Send a text message to a keyword

Send a text message to the subscribed members of one or more keywords. If a member is in multiple keywords, they will only receive the message once.

URL:

http://api.optitmobile.com/1/sendmessage/keywords.{format}

Format:

xml, json

HTTP Method:

POST

Parameters:

keyword_id - the keyword_id of the keyword the message is coming from and the member is subscribed to. It is the ID attribute in the Keyword entity and can be viewed using the Get Keyword method. (Required)

title - the title of the message. This does not appear in the text message and is just used in the application as a short description of your message. (Required)

message - the message being sent to the member. The message must be less than 160 characters including your keyword in the beginning of the message. (Required)

schedule_date - a text value containing the date and time to schedule this message to be sent in the future in the format YYYYMMDDhhmm. (Optional)

XML Response

<?xml version="1.0" encoding="UTF-8"?>
    <message>
        <request_id>1b856ad4-2403-4600-96bd-8bf0959cbc8a</request_id>
    </message>

Send a text message to an interest

Send a text message to the subscribed members of one or more interests. If a member is in multiple interests, they will only receive the message once. Not all interests have to be associated to the same keyword.

URL:

http://api.optitmobile.com/1/sendmessage/interests.{format}

Format:

xml, json

HTTP Method:

POST

Parameters:

• interest_id - the interest_id of the interest the members are subscribed. It is the ID attribute in the Interest entity and can be viewed using the Get Interest method. (Required)
• title - the title of the message. This does not appear in the text message and is just used in the application as a short description of your message. (Required)
• message - the message being sent to the member. The message must be less than 160 characters including your keyword in the beginning of the message. (Required)
• schedule_date - a text value containing the date and time to schedule this message to be sent in the future in the format YYYYMMDDhhmm. (Optional)

XML Response

<?xml version="1.0" encoding="UTF-8"?>
    <message>
        <request_id>1b856ad4-2403-4600-96bd-8bf0959cbc8a</request_id>
    </message>