Skip to main content
GET
/
whatsapp
/
campaigns
/
{_id}
Get campaign details and recipients
curl --request GET \
  --url https://api.otpiq.com/api/whatsapp/campaigns/{_id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "_id": "<string>",
    "campaignId": "<string>",
    "name": "<string>",
    "template": "<string>",
    "phoneNumber": "<string>",
    "scheduledFor": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "totalRecipients": 123,
    "sentCount": 123,
    "deliveredCount": 123,
    "failedCount": 123,
    "estimatedTotalCost": 123,
    "reservedAmount": 123,
    "reconciledAmount": 123,
    "isSampleCampaign": true,
    "sampleOfCampaign": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "recipients": [
      {
        "_id": "<string>",
        "phoneNumber": "<string>",
        "templateParameters": {
          "body": {},
          "header": {},
          "buttons": {}
        },
        "estimatedCost": 123,
        "finalCost": 123,
        "errorMessage": "<string>",
        "sentAt": "2023-11-07T05:31:56Z",
        "deliveredAt": "2023-11-07T05:31:56Z",
        "readAt": "2023-11-07T05:31:56Z",
        "failedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "linkedSampleCampaigns": [
      {
        "_id": "<string>",
        "name": "<string>",
        "campaignId": "<string>",
        "totalRecipients": 123,
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "total": 123,
      "pages": 123,
      "page": 123,
      "limit": 123
    }
  }
}

Authorizations

Authorization
string
header
required

Project API key (sk_live… or sk_dev…). Send it as Authorization: Bearer <api_key>.

Path Parameters

_id
string
required

Campaign MongoDB id returned on create

Pattern: ^[a-fA-F0-9]{24}$

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 500
status
enum<string>

Filter paginated recipients by delivery status

Available options:
queued,
sent,
delivered,
read,
failed
phoneNumber
string

Partial phone number search on recipients

Response

Campaign with paginated recipients

success
enum<boolean>
required
Available options:
true
data
object
required