v1

latestOpenAPI 3.0.12026-07-2471135326.0 KB

Broadcasts

List Broadcasts

This endpoint returns a list with the Broadcasts that were created by the "owner". Query parameters are supported.

get/v2/broadcasts

Query parameters

limitinteger

Use limit operator to limit the number of records returned

skipinteger

Use skip operator to skip the specified number of records

sortstring

Use sort operator to sort records returned. It accepts a comma-separated list of fields. Use - prefix to sort in descending order and + to sort in ascending order

Response

Broadcasts successfully retrieved

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  },
  "pagination": {
    "offset": "e3293115e2ec5f466c67e047",
    "limit": 6,
    "next": "5f466c67e047e3293115e2ec",
    "page": 1,
    "pages": 10,
    "total": 1000
  },
  "items": [
    {
      "id": 1,
      "beginDate": "2020-08-08T19:43:36.278949Z",
      "endDate": "2020-08-08T19:46:36.278949Z",
      "deliveryMethod": "SMS",
      "campaignName": "Billing notice",
      "createdBy": "root",
      "operator": "root",
      "description": "Payment notification to users subscribed to the service",
      "listId": 1,
      "listSize": 1000,
      "listField": "mobile",
      "filters": "mobile%5B%24like%5D%3D%2B",
      "filterName": "only sms users",
      "segmentId": "5fa14d7689ad7743152b0cf0",
      "message": "Payment notification to users subscribed to the service",
      "origin": "8888",
      "broadcastDate": "2020-08-08T19:43:36.278949Z",
      "broadcastStatus": "DONE",
      "createdAt": "2020-08-08T19:43:36.278949Z",
      "throttle": 120,
      "callbacks": [
        "http://www.mycalbackk.com?id=1",
        "http://www.mycalbackk.com?id=2",
        "http://www.mycalbackk.com?id=3"
      ],
      "notSentCounter": 120,
      "messagesSentCounter": 880,
      "smsField": "mobile",
      "emailField": "email",
      "clientId": "cpf",
      "fallback": {
        "fallback": {
          "channels": [
            {
              "type": "SMS",
              "from": "4242"
            }
          ]
        }
      },
      "multimediaFileName": "filename",
      "requestDR": true,
      "subject": "Updates to our Terms of Service",
      "draftId": "149",
      "attachmentName": "dummy.pdf",
      "rcsConfig": {
        "rcsMessage": {
          "title": "Demo",
          "description": "Hi [[mobile]]",
          "cardImageUrl": "https://branding-logos.s3.amazonaws.com/spaces/162/sidebarLogo.png",
          "mediaHeight": "short",
          "cardOrientation": "horizontal",
          "thumbnailAlignment": "right"
        },
        "rcsMessageType": "standalonecard"
      },
      "whatsappConfig": {
        "whatsappTemplateName": "template-name"
      }
    }
  ]
}