Developers & API: Subscriptions

Get a list of subscriptions

Get a list of subscribed members for an individual keyword.

URL:

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

Format:

xml, json

HTTP Method:

GET

Parameters:

• phone - mobile phone number of the member with country code - 1 for U.S. phone numbers. Example: 12225551212
• member_id - the member_id of a member. It is the ID attribute in the Members entity and can be viewed using the Get Member method.
• first_name - first name of the member
• last_name - last name of the member
• zip - zip code or postal code of the member
• gender - gender of the member. Values: [male, female]
• signup_date_start - yyyymmddhhmmss
• signup_date_end - yyyymmddhhmmss

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<subscriptions type="array" current_page="1" total_pages="1">
    <subscription>
        <type>mobile</type>
        <phone>12225551212</phone>
        <member_id>123456</member_id>
        <signup_date>06/10/04 10:40 AM Central Standard Time</signup_date>
        <created_at>06/10/04 10:40 AM Central Standard Time</created_at>
        <url>http://api.optitmobile.com/1/keywords/{keyword_id}/subscriptions/{phone}.{format}</url>
        <url_member>http://api.optitmobile.com/1/members/{phone}.{format}</url_member>
    </subscription>
    <subscription>
        ........
    </subscription>
</subscriptions>

Get an individual subscription.

Get an individual subscription

URL:

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

Format:

xml, json

HTTP Method:

GET

XML Response

<?xml version="1.0" encoding="UTF-8"?>
    <subscription>
        <type>mobile</type>
        <phone>12225551212</phone>
        <member_id>123456</member_id>
        <signup_date>06/10/04 10:40 AM Central Standard Time</signup_date>
        <created_at>06/10/04 10:40 AM Central Standard Time</created_at>
        <url_member>http://api.optitmobile.com/1/members/{phone}.{format}</url_member>
    </subscription>

Subscribe a member to a keyword

Subscribes a member to a keyword. The response will be an unique identifier for tracking of the message. A successful request will initiate the double opt-in process by sending the user the "Web Form Verification Message" text message asking them to confirm their subscription.

Under certain circumstances, single opt-ins or bypassing the opt-in process in full can be put in place. This can be used if permission is already being granted elsewhere. Please email support at optit.com to see if your application qualifies. If a user has blocked messages to their phone, nothing will be sent.

URL:

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

Format:

xml, json

HTTP Method:

POST

Parameters:

• phone - mobile phone number of the member with country code - 1 for U.S. phone numbers. (Phone or member_id is required)  Example: 12225551212
• member_id - the member_id of a member. It is the ID attribute in the Members entity and can be viewed using the Get Member method. (Phone or member_id is required)
• interest_id - add this user to one or many interests. For multiple interests, please comma separate the interest_ids. It is the ID attribute in the Interest entity and can be viewed using the Get Interest method.
• first_name - first name of the member
• last_name - last name of the member
• address1 - address line 1 of the member
• address2 - address line 2 of the member
• city - city of the member
• state - state of the member as a two character abbreviation
• zip - zip code or postal code of the member
• gender - gender of the member. Values: [male, female]
• birth_date - birthdate in the format yyyymmdd
• email_address - email address of the member

XML Response

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