A campaign's messages

Per person: number, status, why it did not reach them, price. Up to 1,000 a page. Read them all in order with cursor (each answer’s next_cursor); page still works.

Permission: Any key (Full, Send only or Read only).

GET /v1/campaigns/{id}/messages

A campaign's messages

cURL

curl --request GET \
  --url https://api.getreply.in/v1/campaigns/{id}/messages \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "data": [
    {
      "id": "<string>",
      "to": "<string>",
      "customer": {
        "phone": "<string>",
        "user_id": "<string>",
        "username": "<string>"
      },
      "country": "<string>",
      "type": "<string>",
      "category": "<string>",
      "campaign_id": "<string>",
      "campaign_reference": "<string>",
      "text": "<string>",
      "media": {
        "id": "<string>",
        "type": "<string>",
        "mime_type": "<string>"
      },
      "status": "accepted",
      "reason": "<string>",
      "failure": {
        "code": "<string>",
        "message": "<string>"
      },
      "price": "<string>",
      "charged": "<string>",
      "currency": "<string>",
      "reference": "<string>",
      "created_at": "<string>",
      "accepted_at": "<string>",
      "delivered_at": "<string>",
      "read_at": "<string>",
      "failed_at": "<string>",
      "timeline": [
        {
          "status": "<string>",
          "at": "<string>"
        }
      ]
    }
  ],
  "page": 123,
  "per_page": 123,
  "total": 123,
  "next_cursor": "<string>"
}

Authorizations

Authorization · string · header · required

Your API key, e.g. gr_live_…

Path Parameters

id · string · required

The id.

Query Parameters

status · string

Filter by a message status.

page · integer · default: 1

Page number, from 1 (or use cursor).

Required range: x >= 1

per_page · integer · default: 50

How many on a page (at most 1000).

Required range: 1 <= x <= 1000

cursor · string

next_cursor from the page before. Leave out for the first page.

Response

200

application/json

A page of messages.

data · object[]

Show child attributes

page · integer | null

per_page · integer

total · integer

next_cursor · string | null