---
title: "GET SMS Engagement History for a Contact"
method: GET
path: "/contacts/sms_engagement_history/{contact_id}"
tags: ["Contacts"]
---

# GET SMS Engagement History for a Contact

`GET /contacts/sms_engagement_history/{contact_id}`

Use this method to return SMS engagement details for a contact, such as SMS consent and advertising frequency details.

## Path parameters

- `contact_id` string, required

## Response `200`

Request successful

- object[]
  - `contact_id` string — The unique contact UUID.
  - `sms_channel_id` string — The unique SMS channel UUID.
  - `sms_channel_history_id` string — The unique SMS channel history UUID.
  - `insert_time` string, date-time — The date and time that the history record was created, in ISO-8601 format. System generated.
  - `history_details` HistoryDetails — Additional details about the SMS consent actions (opt-in, opt-out) in JSON format. The <code>consent_action_type</code> and the method used to add or update a contacts SMS details determines which properties are returned in the results.
    - `state` string — The code representing the consent state, including <code>E</code> for optin and <code>O</code> for Optin.
    - `source` string — The code representing the consent source type, including <code>A</code> for Account, <code>C</code> for Contact, and <code>S</code>' for System.
    - `consent_type` string — The type of SMS consent used.
    - `consent_action_time` string, date-time — The date and time that SMS engagement data was last updated, in ISO-8601 format. System generated.
    - `consent_action_type` string — The type of consent action provided.
    - `consent_medium_type` string — The code representing the medium used to provide consent. Medium types include mobile device (<code>MD</code>). lead generation form(<code>LF</code>), deactivation by carrier(<code>CD</code>), import_file:(<code>FI</code>), and system (<code>SY</code>).
    - `source_consent_timestamp` string — The time that SMS consent was last updated.
    - `source_sms_number` string — If applicable, the SMS consent number associated with the source.
    - `advertised_frequency` integer — If applicable, the advertising numeric component used to advertise to the contact.. For example, if <code>advertised_frequency</code> is set to <code> 2</code> , and <code>advertised_interval</code> is set to <code>M</code>, the contact receives advertisements twice a month.
    - `advertised_interval` string — If applicable, the interval component used to advertise to the contact. For example, if <code>advertised_frequency</code> is set to <code> 2</code> , and <code>advertised_interval</code> is set to <code>M</code>, the contact receives advertisements twice a month.

## Other responses

- `400` — Bad request. Either the JSON was malformed or there was a data validation error.
- `401` — The Access Token used is invalid.
- `403` — Forbidden request. You lack the necessary scopes, you lack the necessary user privileges, or the application is deactivated.
- `404` — The requested resource was not found.
- `500` — There was a problem with our internal service.
- `503` — Our internal service is temporarily unavailable.

---

[API](https://skmtc.net/cc/apis/appconnect-v3.md) · [All operations](https://skmtc.net/cc/apis/appconnect-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cc/appconnect-v3/revisions/4b4a534c818d/schema)