4.18h

TextMarks API V2 - AutoDoc: RegisteredUser / sms_conversations()

Method: sms_conversations() (GET) - Load SMS conversation data related to auth_user's TextMarks

Package: RegisteredUser - Manage authenticated user's account/profile (... View package)

Args:

Req? Name Type Description Test
REQ auth_user User User account / phone# used for login
REQ auth_pass Password Password
REQ time_secs Integer Report over this many seconds back from time_end (max 86400)
OPT api_key API Key API Key (Register here)
OPT time_end Timestamp Report starting at this time (up to 60 days ago), going backward time_secs
OPT filter_tm TextMark Filter to include only this TextMark
OPT filter_user User Filter to include only conversations with this user (phone or nick)
OPT filter_ignore_mtonly Bool (0/1) Filter to only include conversations where user texted something
OPT filter_only_with_errors Bool (0/1) Filter to only include conversations with errors in them
OPT offset Integer 0-based result to start with (default 0)
OPT count Integer #results desired (max 10000) (default 500)

Test:


Docs:

  • Report/log of various SMS conversations between real users' phones and your keywords.
  • Status: This API method is in alpha state (as of 2012-10) and subject to change.
  • Report lists conversations sorted from newest to oldest.
  • About filters:
    filter_tm
    Normally all keywords owned by the auth_user are reported on. Specify this TextMark filter (keyword) to only report on conversations related to this keyword.
    filter_user
    Normally all users interacting with keywords in question are included in the report. Specify this user filter (most often as a phone#) to only report on specific conversations with that user.
    filter_ignore_mtonly
    Normally each alert broacast recipient will show as a separate conversation. Enable this filter to ignore conversations like this that the user didn't participate in.
  • The pagination params offset and count don't map directly to conversations, but more closely represent specific exchanges within conversations (based on the underlying data model) used to assemble conversations. Because underlying records are newest-to-oldest, paging forward will not only yield additional conversations, but may also extend already found conversations further back in time. The scanned value in the response indicates the number of records scanned, and if this value is equal to count, then there are likely more records available by additional API requests with an increased offset, even if no or few conversations were returned by this specific call.

Resp:

JSON response.head.rescode==0 for success, or error code otherwise.
JSON-P callback: (as 'jsonp' param, optional) (blank for none)

HTTP:

GET https://api2ssl.textmarks.com//RegisteredUser/sms_conversations/

More:

This page documents a single API function sms_conversations() within the RegisteredUser package of the TextMarks Text Message API.
You may use the interactive form above to invoke this function and observe its actual JSON response.

More resources: