Response Codes and Reporting Differences

This page covers the difference between v3 and v4 response error codes and reporting.

If you're currently using our v3 API, then this information is for you. If you're new to OpenMarket, see the Overview to find out how to connect to us.

Response error codes

The response error codes returned with v4 differ from v3 in the following ways:

  • The code numbering has changed. For example, issues with the format or syntax of your request all use the new code 540.
  • We removed codes for attributes/elements that are not in v4.
  • We added new codes for attributes/elements that are new in v4.

You can find the list of possible error codes for each operation on the operation's page.

For delivery receipt codes, see Delivery Receipts and Response Codes.

Reports and activity search

Important: We recommend migrating to our new Reporting Insights, rather than continuing to use MAR reports.

You can use both the SMS Message Activity Reports (MAR) and the SMS Activity Search tool regardless of whether you're using the v3 or v4 API. However, to support v4, the MAR reports and activity search include two new charge types:

  • 33 — enterprise one-way messaging
  • 39 — enterprise two-way messaging

Charge type 0 is not returned for v4.

One of the benefits of v4 is better multipart message tracking, supported by the SMS Activity Search tool. Because each multipart message is given one ticket ID, when you enter the ticket ID in the activity search, we return all parts of a multipart message.