[HTTP GET] ~/contacts/{contactId}/textmessages

Description: Get a list of a Contact's TextMessage Interactions

Request Information

ODATA Queryable

URI Parameters

NameDescriptionTypeAdditional information
contactId

Encrypted Contact Id

 string

Required

Body Parameters

None

Response Information

Description

Successful Response - OK (200):

A collection of ContactTextMessageDTO

Response Content : Collection of ContactTextMessage

NameDescriptionTypeAdditional information
Id

The Text message's ID

 integer

None.
Name

The name of the Text Message

 string

None.
Date

The date of the Interaction

 date

None.
Delivered

Was the TextMessage delivered?

 integer

None.

Response Codes:

  • 200 - OK
    • The specified Contact's TextMessage Interactions were retrieved and returned successfully.
  • 401 - Unauthorized
    • Request has been denied as it lacks valid Authentication credentials.
  • 403 - Forbidden
    • The user does not have the relevant permissions to perform this action.
  • 404 - NotFound
    • The specified Contact was not found.
  • 500 - InternalServerError
    • An error occurred while processing this request.

Formats

application/json, text/json

Sample: 
[
  {
    "Id": 1,
    "Name": "sample string 2",
    "Date": "2024-12-27T18:53:41.1761522+00:00",
    "Delivered": 3
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "Date": "2024-12-27T18:53:41.1761522+00:00",
    "Delivered": 3
  }
]

application/csp-report

Sample: 
[{"Id":1,"Name":"sample string 2","Date":"2024-12-27T18:53:41.1761522+00:00","Delivered":3},{"Id":1,"Name":"sample string 2","Date":"2024-12-27T18:53:41.1761522+00:00","Delivered":3}]

application/xml, text/xml

Sample: 
<ArrayOfContactTextMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO.Contacts">
  <ContactTextMessage>
    <Date xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-12-27T18:53:41.1761522Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </Date>
    <Delivered>3</Delivered>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </ContactTextMessage>
  <ContactTextMessage>
    <Date xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-12-27T18:53:41.1761522Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </Date>
    <Delivered>3</Delivered>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </ContactTextMessage>
</ArrayOfContactTextMessage>