Skip to main content
GET
/
public-api
/
campaigns
/
{id}
/
get-messages
Retrieve messages for a specific campaign
curl --request GET \
  --url https://agents.nineteen58.co.za/public-api/campaigns/{id}/get-messages \
  --header 'x-api-key: <api-key>'
{
  "messages": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "earliest_at": "2023-11-07T05:31:56Z",
      "sent_at": "2023-11-07T05:31:56Z",
      "contact": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "identifier": "<string>"
      },
      "step_name": "<string>"
    }
  ],
  "totalCount": 123,
  "currentPage": 123,
  "pageSize": 123,
  "totalPages": 123
}

Authorizations

x-api-key
string
header
required

Headers

x-api-key
string
required

API key for authentication

Path Parameters

id
string<uuid>
required

Campaign ID

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1
pageSize
integer
default:10

Number of items per page

Required range: 1 <= x <= 100

Response

Successfully retrieved campaign messages

messages
object[]
totalCount
integer
currentPage
integer
pageSize
integer
totalPages
integer