v1

latestSwagger 2.0Private2026-08-04128286690.5 KB

Contacts

GET SMS Engagement History for a Contact

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

get/contacts/sms_engagement_history/{contact_id}

Path parameters

contact_idstring required

The contact's unique ID.

Response

Request successful

contact_idstring

The unique contact UUID.

sms_channel_idstring

The unique SMS channel UUID.

sms_channel_history_idstring

The unique SMS channel history UUID.

insert_timestring date-time

The date and time that the history record was created, in ISO-8601 format. System generated.

Example response

[
  {
    "contact_id": "7f7923da-ebf7-11ec-ae6e-3e22fbb230ec",
    "sms_channel_id": "3fa85f64-5712-6245-b3fc-2c963f66bfc6",
    "sms_channel_history_id": "04515cb3-17be-41e4-823a-f71c3d381c7b",
    "insert_time": "2016-03-03T10:53:04-05:00",
    "history_details": {
      "state": "O",
      "source": "A",
      "consent_type": "promotional_sms",
      "consent_action_time": "2023-01-23 06:09:23 -0800",
      "consent_action_type": "opt_out",
      "consent_medium_type": "MD",
      "source_consent_timestamp": "2016-03-03T10:53:04-05:0",
      "source_sms_number": "6035550239",
      "advertised_frequency": 2,
      "advertised_interval": "W"
    }
  }
]