Transactional Messaging - OTT

GET Get a list of OTT send definitions. The number of records that the method returns is based on the $pageSize and $page parameters. It doesn't necessarily return all the records in one call.

GET /messaging/v1/ott/definitions/

Operation ID: Get all send definitions.

Parameters

  • Authorization (header, string, required)
    Example: Bearer YOUR_ACCESS_TOKEN.
  • $page (path, integer) This parameter selects the page returned from paginated results.
    Example: 2.
  • $pageSize (path, integer) This parameter selects the size of the page of the results.
    Example: 40.
  • $count (path, integer) This parameter is the count of results to return per page.
    Example: 10.

Responses

  • 200 Success

    Media type: application/json. Schema: getSendDefinitionResponse.

    Example: Example Response

    {
      "requestId": "27de1564-15ff-4310-8ca5-40ea1c7fada5",
      "definitions": [
        {
          "name": "account-reset",
          "definitionKey": "account-reset",
          "status": "Active",
          "createdDate": "2024-01-13T11:03:31.4133333",
          "modifiedDate": "2024-01-13T11:03:31.4133333"
        },
        {
          "name": "account-reset",
          "definitionKey": "my_unique_1",
          "status": "Active",
          "createdDate": "2024-01-13T05:21:26.48",
          "modifiedDate": "2024-01-13T05:21:26.48"
        },
        {
          "name": "account-reset",
          "definitionKey": "account-reset45",
          "status": "Active",
          "createdDate": "2024-01-13T04:56:40.0266667",
          "modifiedDate": "2024-01-13T04:56:40.0266667"
        },
        {
          "name": "account-reset",
          "definitionKey": "my_video_def_13",
          "status": "Active",
          "createdDate": "2024-01-15T06:27:59.18",
          "modifiedDate": "2024-01-15T06:27:59.18"
        },
        {
          "name": "account-reset",
          "definitionKey": "my_video_def_14",
          "status": "Active",
          "createdDate": "2024-01-15T07:19:04.1666667",
          "modifiedDate": "2024-01-15T07:19:04.1666667"
        }
      ],
      "count": 5,
      "page": 2,
      "pageSize": 5
    }