SMS Activity Search

The SMS Activity Search tool lets you obtain status and other information about messages that OpenMarket processes for data four months prior to the Message Accepted date. Records are saved for a default period of four months once it is recorded in the application log. After four months the record is deleted. Customers cannot set their own retention periods. For more information on data retention, see GDPR compliance.

In this topic you will find:

Accessing SMS Activity Search

SMS Activity Search is accessed from Customer Center by clicking Tools, and then clicking SMS Activity Search:

The SMS Activity Search page appears:

Screenshot of the SMS Activity Search tool

On this page you can search for message activity by any of the following:

  • Phone Number(s) — The phone number for the end user. This is the default setting when accessing SMS Activity Search.
  • Message ID(s) — The unique ID(s) assigned to the SMS message(s) by OpenMarket.
  • Subaccount — Any subaccount associated with the message.
  • Note 2 — Any free-text that was added to the Note 2 field of the message.

If you are using RCS, and are provisioned for SMS fallback, you can use SMS Activity Search to search for SMS message activity. However, SMS Activity Search does not support searching for RCS message activity. For more information on how SMS fallback works, see Features of RCS.

Note: Subaccount and Note 2 are optional parameters in sent (MT) messages. If your message did not include either of these parameters, no information will be returned. In addition,

Subaccount is only available when using the UKGW API. It is not used in either of the Global SMS APIs.
Note 2 is only available when using either the SMPP Global SMS API  or the HTTP Global SMS API.

Based on your selections, SMS activity data is returned. This information is described below in SMS Search Activity results fields.

To use SMS Activity Search:

  1. Log on to Customer Center and under the Tools menu, select SMS Activity Search.

  2. Select a search option: Phone Number, Message ID(s), Subaccount, or Note 2.

    The search text box adjusts based on your selection. The search text box also indicates how you should enter your search criteria.

  3. Enter the relevant information in the text box based on the Search By selection.

    • If you select Phone Number(s) or Message IDs(s) enter one or more phone numbers or one or more message IDs. Enter only one phone number or message ID per line.
    • If you select Subaccount enter a single subaccount number. Multiple subaccount numbers are not supported.
    • If you select Note 2, enter the text exactly as it was added in the Note 2 field of the message. Partial text and multiple Note 2 fields are not supported.

      Note: Searching by Subaccount and Note 2 can be time-consuming. When selecting these fields to search by, be aware that the process can take several minutes or more to complete. In some cases, the search might time out before finding any results. Time out is set to 30 minutes. To shorten the time it takes to run the search, consider narrowing down the time frame using the Start Date and End Date, or to close the window to cancel an activity report that's taking too long.

      An alternative to using SMS Activity Search for Subaccount and Note 2 would be to create a custom SMS Detailed report in Reporting Insights using these fields. See SMS Detailed Reference for the steps.

  4. Enter a date range to narrow results. The date and time are based on when you submitted the messages. Dates are formatted using MM/DD/YYYY. The time field uses the 12-hour AM/PM format.

    • For Phone Number(s) and Message ID(s), the time frame within which you can search is 30 days from the selected Start Date.
    • For Subaccount and Note 2, the time frame within which you can search is two weeks back from the current date, and you can only select a time period of 0-24 hours within a single 24-hour period. The default value is six.
  5. Click Search.

    Activity Search returns the results in a grid, with up to 50 results displayed in the default Simple view, and with a maximum of 500 total results returned. To view more than 500 results, click either the Export CSV or Export ZIP link on the results page to download the results in a format that you can open as a spreadsheet, which returns all records. See SMS Search Activity results fields below for descriptions of the fields.

    Screenshot showing the result of an SMS Activity Search

    Note: Click Go to full-page version to open your workspace in a new window with right- and left-pane navigation removed. To return to the default view, click SMS Messaging above the SMS Activity Search title. Switching between views resets your workspace. Make sure that you set your preferred view before performing a search.

SMS Search Activity results fields

The information in the following table describes the fields returned in the SMS Activity Search results.

Summary view

Field

Description

Message ID

The identifier OpenMarket assigns to your message.

Multipart messages have message IDs for each message part and for the entire message. This means the table has an entry for each part and an entry for the entire message.

Parent Message ID

For multipart messages only, this column shows the ID of the entire message.

Account ID

The ID of your OpenMarket account.

Message Type

Indicates whether the message is an MO (mobile originated) or MT (mobile terminated).

Message Status

The current or final delivery status of a message, which can be: Delivered, Awaiting Report, or Failed.

Delivery Receipt Code

A number that identifies the current or final delivery state of a message, such as: 0 (message sent), 4 (message delivered), 811 (message delivery error-message expired).

Phone Number

The phone number that serves as the source or destination number for the SMS message.

Originator

The source number used to send an MT message or receive an MO message. Originators include short codes, text-enabled landlines, toll-free numbers, and long codes.

Operator ID

The OpenMarket ID for the mobile operator associated with the end user's phone number.

Operator Name

The name of the mobile operator associated with the end user's phone number.

Content

The contents of the SMS message. This will be either text or binary data.

Charge Type

A number that indicates the type of messaging interaction.

If you are using our HTTP Global SMS API, this can be:

  • 0 — Canada and US standard rate
  • 33 — enterprise global one-way
  • 39 — enterprise global two-way

If you are using our legacy SMS v3 API, this can be:

  • 0 — Canada and US standard rate
  • 20 — international SMS

Changes to SMS Activity Search

In June 2018, changes were made so that field labels returned on SMS Activity Search results page use the same labels as those on the SMS Summary and SMS Detailed reports. The table below notes the specific changes.

Old Label

New Label

Ticket ID

Message ID

Parent Ticket ID Parent Message ID
State Message Status
Response Code Delivery Receipt Code
Short Code Originator
Carrier Operator
Message Content
Submitted Date Accepted Date
Program ID US Program ID
Carrier Lookup Operator Lookup
UDH Flag User Data Header