SMsmileapi
Blacklists (Alpha)

List Blacklists

Changed on

List all Blacklists.

get/alpha/blacklists

Request

  • Base URL
    https://sandbox.smileapi.io/v1
  • URL
    https://sandbox.smileapi.io/v1/alpha/blacklists
  • Auth
    HTTP basic

Query parameters

sizeinteger
Example:50

The number of objects you want returned in a collection.

cursorstring

Uses the filter values of the previous page to determine the next set of items.

blacklistIdstring

Filter blacklists by a specific Blacklist ID.

mobileNumberstring

Filter blacklists by a specific mobile number.

type'BLACKLIST1' | 'BLACKLIST2'

Filter blacklists by Blacklist type.

startDatestring date

Filter blacklists by the start date of the request range (YYYY-MM-DD).

endDatestring date

Filter blacklists by the end date of the request range (YYYY-MM-DD).

Response

OK

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "nextCursor": "1259723474",
    "items": [
      {
        "createdAt": "2021-04-14T09:30:24Z",
        "requestMeta": {
          "mobileNumber": "639559991234",
          "countryCode": "PH",
          "templateId": "tpl-blk002001",
          "applicationDate": "2023-01-21",
          "hitThreshold": 3,
          "consent": {
            "type": "Terms and Conditions",
            "version": "1.0.0",
            "consentedAt": "2021-04-14T09:30:24Z",
            "consentedWith": "I agree to the terms and conditions"
          }
        },
        "result": {
          "dates": [
            "2000-01-21"
          ]
        }
      }
    ]
  }
}

Changes

  • v17b9b7182268aRevision changes
    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

  • v1a68faef4b017Revision changes
    • breaking

      the ///////// response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the ///////// response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the ///////// response's property type changed from string to no type, and format from date-time to no format for status

    • info

      added to the ///////// response property allOf list for the response status

    • info

      added to the ///////// response property allOf list for the response status

    • info

      added to the ///////// response property allOf list for the response status