Retrieve Campaign Reply Messages

Retrieve all reply messages for a campaign. Use sortBy and sortDir to sort the results, and use page and recordsPerPage to limit the number of results returned.

Endpoint

GET /v1/campaigns/{id}/replies

Authorization Header

Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding

Path Parameters

id REQUIRED

string (UUID)

Unique ID assigned to the campaign in RocketCOMS.

Query Parameters

sortBy

string

Sort the response by any field.

sortDir

string, values: desc, asc

Sort direction.

page

integer (int32), default: 0

Page number to return.

pageSize

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns an array of reply messages. The following fields are returned for each message.

string (UUID)

Unique ID assigned to the message.

source

string

Phone number from which the reply was sent.

sourceCountry

string

Country for the source phone number.

sourceCountryCode

string

Country code for the source phone number.

sourceCountryAbbreviation

string

Short country code for the source phone number.

destination

string

Phone number to which the reply was sent.

messageText

string

Message text.

concatenatedMessage

boolean

Whether the message was concatenated.

createdAt

string (date-time)

Date and time the message was received.

lastRetrievedAt

string (date-time)

Date and time the message was last retrieved from the Direct Connect Aggregator (DCA).

SAMPLE RESPONSE

				
					[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "source": "5555551234",
    "sourceCountry": "United States",
    "sourceCountryCode": "USA",
    "sourceCountryAbbreviation": "US",
    "destination": "5555556789",
    "messageText": "Yes",
    "concatenatedMessage": true,
    "createdAt": "2022-04-24T00:39:04.638Z",
    "lastRetrievedAt": "2022-04-24T00:39:04.638Z"
  }
]