Welcome to Opt It Mobile

Opt It Mobile is the industry-leading text message marketing application that helps you engage, build brand awareness and create a direct dialogue with your customers.

Learn more at Opt It. If you have an account, please login.

Try Opt It Mobile. Start your 30 day free trial.

Help: Opt It Mobile

Developers & API: Keywords

Get the list of keywords

Get the list of keywords for the authenticated user.

URL:

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

Format:

xml, json

HTTP Method:

GET

Parameters:

  • keyword - the name of a keyword
  • short_code - the 5 or 6 digit short code of a keyword
  • page - the number of the page result that you are requesting.

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<keywords type="array" current_page="1" total_pages="1" >
    <keyword>
        <id>123456</id>
        <internal_name>KEYORD1</internal_name>
        <keyword_name>KEYORD1</keyword_name>
        <short_code>46786</short_code>
        <status>active</status>
        <created_at >06/10/04 10:40 AM Central Standard Time</created_at>
        <keyword_type >subscription</ keyword_type>
        <mobile_subscription_count>1233</ mobile_subscription_count>
        <url>http://api.optitmobile.com/1/keywords/{keyword_id}.{format}</url>
        <url_subscriptions>http://api.optitmobile.com/1/keywords/{keyword_id}/subscriptions.{format}
        </url_subscriptions>
        <url_interests>http://api.optitmobile.com/1/keywords/{keyword_id}/interests.{format}
        </url_interests>
    </keyword>
    <keyword>
        .........
    </keyword>
</keywords>


Get an individual keyword

Get an individual keyword

URL:

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

Format:

xml, json

HTTP Method:

GET

XML Response

<?xml version="1.0" encoding="UTF-8"?>
    <keyword>
        <id>123456</id>
        <internal_name>KEYORD1</internal_name>
        <keyword_name>KEYORD1</keyword_name>
        <short_code>46786</short_code>
        <status>active</status>
        <created_at >06/10/04 10:40 AM Central Standard Time</created_at>
        <keyword_type >subscription</ keyword_type>
        <mobile_subscription_count>1233</ mobile_subscription_count>
        <url_subscriptions>http://api.optitmobile.com/1/keywords/{keyword_id}/subscriptions.{format}
        </url_subscriptions>
        <url_interests>http://api.optitmobile.com/1/keywords/{keyword_id}/interests.{format}
        </url_interests>
        <billing_type>per-message</billing_type>
        <interest_id>56473</interest_id>
        <welcome_msg_type>semi-custom</welcome_msg_type>
        <welcome_msg>Thanks for joining our Mobile VIP Club. Show this to receive 10% off your bill.</welcome_msg>
        <web_form_verification_msg_type>semi-custom</web_form_verification_msg_type>
        <web_form_verification_msg>Thanks for your interest in our Mobile VIP Club. Please verify your phone number.
        </web_form_verification_msg>
        <already_subscribed_msg_type>custom</already_subscribed_msg_type>
        <already_subscribed_msg>You already joined our VIP Mobile Club. Stay tuned for the latest updates and offers.
        </already_subscribed_msg>
    </keyword>


Check the availability of a keyword

Checks to see if a keyword is already being used on the short code in your account. If it does not already exist, you will be allowed to add it to your account.

URL:

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

Format:

xml, json

HTTP Method:

GET

Parameters:

  • keyword - the name of a keyword. (Required)

XML Response

<?xml version="1.0" encoding="UTF-8"?>
    <keyword>
        <exists>false</exists>
        <keyword_name>KEYORD1</keyword_name>
        <short_code>46786</short_code>
    </keyword>


Add a new keyword

Adds a new keyword for the short code assigned to your account. This will default to a Subscription keyword type and will use the standard Opt It messaging unless other message parameters are included in your POST. Your account will be billed based on your account plan and the billing type you submit.

URL:

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

Format:

xml, json

HTTP Method:

POST

Parameters:

  • billing_type - the plan type for this keyword. Values: [unlimited, per-message] (Required)
  • keyword - the name of the keyword. (Required)
  • internal_name - the internal name of the keyword. This name is only used for reference purposes inside the application. (Required)
  • interest_id - the interest_id that users wil be added to when they subscribe. It is the ID attribute in the Interest entity and can be viewed using the Get Interest method.
  • welcome_msg_type - the type of welcome messaage for this keyword. This message is sent after a successful subcription for a member. Defaults to standard. Values: [standard, semi-custom]
  • welcome_msg - the actual text to be sent in the welcome message. Welcome_msg_type must exist in the POST and be equal to "semi-custom". Max 93 characters.
  • web_form_verification_msg_type - the type of web form verification messaage for this keyword. This message is sent when someone subscribes using a web form or using the API and asks the member to verify that they would like to subscribe. It prevents someone other than the phone owner from subscribing the member's phone number to a keyword. Defaults to standard. Values: [standard, semi-custom]
  • web_form_verification_msg - the actual text to be sent in the web form verification message. Web_form_verification_msg_type must exist in the POST and be equal to "semi-custom". Max 120 characters.
  • already_subscribed_msg_type - the type of already subscribed messaage for this keyword. This message is sent when a member tries to subscribe and they are already subscribed to the keyword. Defaults to standard. Values: [standard, custom, none]
  • already_subscribed_msg - the actual text to be sent in the already subscribed message. Already_subscribed_msg_type must exist in the POST and be equal to "custom". Max 160 characters.

XML Response

<?xml version="1.0" encoding="UTF-8"?>
    <keyword>
        <id>123456</id>
        <internal_name>KEYORD1</internal_name>
        <keyword_name>KEYORD1</keyword_name>
        <short_code>46786</short_code>
        <status>active</status>
        <created_at >06/10/04 10:40 AM Central Standard Time</created_at>
        <keyword_type >subscription</ keyword_type>
        <mobile_subscription_count>1233</ mobile_subscription_count>
        <url_subscriptions>http://api.optitmobile.com/1/keywords/{keyword_id}/subscriptions.{format}
        </url_subscriptions>
        <url_interests>http://api.optitmobile.com/1/keywords/{keyword_id}/interests.{format}
        </url_interests>
        <billing_type>per-message</billing_type>
        <interest_id>56473</interest_id>
        <welcome_msg_type>semi-custom</welcome_msg_type>
        <welcome_msg>Thanks for joining our Mobile VIP Club. Show this to receive 10% off your bill.</welcome_msg>
        <web_form_verification_msg_type>semi-custom</web_form_verification_msg_type>
        <web_form_verification_msg>Thanks for your interest in our Mobile VIP Club. Please verify your phone number.
        </web_form_verification_msg>
        <already_subscribed_msg_type>custom</already_subscribed_msg_type>
        <already_subscribed_msg>You already joined our VIP Mobile Club. Stay tuned for the latest updates and offers.
        </already_subscribed_msg>
    </keyword>


Update a keyword

Updates an existing keyword. All parameters are optional, but you must supply the message type in order to update the contents of a message.

URL:

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

Format:

xml, json

HTTP Method:

PUT

Parameters:

  • billing_type - the plan type for this keyword. Values: [unlimited, per-message] (Required)
  • internal_name - the internal name of the keyword. This name is only used for reference purposes inside the application. (Required)
  • interest_id - the interest_id that users wil be added to when they subscribe. It is the ID attribute in the Interest entity and can be viewed using the Get Interest method.
  • welcome_msg_type - the type of welcome messaage for this keyword. This message is sent after a successful subcription for a member. Defaults to standard. Values: [standard, semi-custom]
  • welcome_msg - the actual text to be sent in the welcome message. Welcome_msg_type must exist in the POST and be equal to "semi-custom". Max 93 characters.
  • web_form_verification_msg_type - the type of web form verification messaage for this keyword. This message is sent when someone subscribes using a web form or using the API and asks the member to verify that they would like to subscribe. It prevents someone other than the phone owner from subscribing the member's phone number to a keyword. Defaults to standard. Values: [standard, semi-custom]
  • web_form_verification_msg - the actual text to be sent in the web form verification message. Web_form_verification_msg_type must exist in the POST and be equal to "semi-custom". Max 120 characters.
  • already_subscribed_msg_type - the type of already subscribed messaage for this keyword. This message is sent when a member tries to subscribe and they are already subscribed to the keyword. Defaults to standard. Values: [standard, custom, none]
  • already_subscribed_msg - the actual text to be sent in the already subscribed message. Already_subscribed_msg_type must exist in the POST and be equal to "custom". Max 160 characters.

XML Response

<?xml version="1.0" encoding="UTF-8"?>
    <keyword>
        <id>123456</id>
        <internal_name>KEYORD1</internal_name>
        <keyword_name>KEYORD1</keyword_name>
        <short_code>46786</short_code>
        <status>active</status>
        <created_at >06/10/04 10:40 AM Central Standard Time</created_at>
        <keyword_type >subscription</ keyword_type>
        <mobile_subscription_count>1233</ mobile_subscription_count>
        <url_subscriptions>http://api.optitmobile.com/1/keywords/{keyword_id}/subscriptions.{format}
        </url_subscriptions>
        <url_interests>http://api.optitmobile.com/1/keywords/{keyword_id}/interests.{format}
        </url_interests>
        <billing_type>per-message</billing_type>
        <interest_id>56473</interest_id>
        <welcome_msg_type>semi-custom</welcome_msg_type>
        <welcome_msg>Thanks for joining our Mobile VIP Club. Show this to receive 10% off your bill.</welcome_msg>
        <web_form_verification_msg_type>semi-custom</web_form_verification_msg_type>
        <web_form_verification_msg>Thanks for your interest in our Mobile VIP Club. Please verify your phone number.
        </web_form_verification_msg>
        <already_subscribed_msg_type>custom</already_subscribed_msg_type>
        <already_subscribed_msg>You already joined our VIP Mobile Club. Stay tuned for the latest updates and offers.
        </already_subscribed_msg>
    </keyword>

Opt It Mobile Help:

Additional Support

For additional support, visit our support page.