Get Customer Campaign Participants

This API is used to retrieve a list of all participants (subscribers) in a specific campaign.

HTTP URL
GET	/api/v2/customer/{id}/campaign/{id}/participants

Eligibility

The Requester is eligible to request and receive the participant list of a specified campaign, which has been marked as connected to its customer.

API Request

Request Structure

This API has no request structure.

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
id	Numeric	M	Participant (subscriber) unique identifier
iccid	String	M	SIM card (subscriber) identifier
status	String	M	SIM message status. ENUM: PENDING, COMPLETED, SUSPENDED, PROGRESS, WAIT, RETRY, CANCELED, CANCELING, EXCEPTION
attempt	Numeric	M	Last message attempt count.
code	String	M	Message result code.
message	String	M	Actual message string.
timestamp	dateTime	M	Campaign creation timestamp.

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
CUSTOMER_1002	Customer does not exist
CUSTOMER_1037	Campaign does not exist

Examples

Request Body: N/A

Copy

{
  "fullData": false
}

Response Body: Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "id": 1030247,
      "iccid": "8935771600000000003",
      "status": "COMPLETED",
      "attempt": 1,
      "code": "200",
      "message": "OK - UPDATE - 3F00/ADF1/6F31 - data: 05 ...",
      "timestamp": "2022-02-11 14:21:53"
    },
    {
      "id": 1040348,
      "iccid": "8935771600000000052",
      "status": "RETRY",
      "attempt": 3,
      "code": "200",
      "message": "OK - UPDATE - 3F00/ADF1/6F31 - data: 05 ...",
      "timestamp": "2022-08-22 14:13:59"
    }
  ],
  "pageable": {
    "page": 1,
    "size": 10,
    "totalPages": 99,
    "totalElements": 988
  }
}

Response Body: Failure NAK

Copy

{
  "errorCode": "CUSTOMER_1037",
  "errorMessage": "Campaign does not exist",
  "content": "",
  "pageable": ""
}