Skip to main content
GET
/
v1
/
messaging
/
sms
/
campaigns
/
{uuid}
Get Campaign Report
curl --request GET \
  --url http://localhost:2222/v1/messaging/sms/campaigns/{uuid}
{
  "success": true,
  "message": "<string>",
  "data": {
    "campaignId": "<string>",
    "workspaceId": 123,
    "name": "<string>",
    "src": "<string>",
    "message": "<string>",
    "priority": "<string>",
    "status": "<string>",
    "totalRecipients": 123,
    "totalUnitsUsed": 123,
    "queued": 123,
    "sending": 123,
    "sent": 123,
    "delivered": 123,
    "failed": 123,
    "pagedMessages": {
      "page": 123,
      "size": 123,
      "totalElements": 123,
      "totalPages": 123,
      "content": [
        {
          "uuid": "<string>",
          "dest": "<string>",
          "status": "<string>",
          "cost": 123,
          "segments": 123,
          "createdAt": "<string>"
        }
      ],
      "links": {}
    },
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Path Parameters

uuid
string<uuid>
required

Query Parameters

page
integer<int32>
default:0
size
integer<int32>
default:50

Response

OK

success
boolean
message
string
data
object