SMsmileapi
Blacklists (Alpha)

Create Blacklist1

Changed on

Create a Blacklist object.

This endpoint requires the following input parameters:
consent, mobileNumber, templateId, and countryCode.

Default Behavior

  • If templateId is not provided, it defaults to tpl-blk002001.
  • If countryCode is omitted, it defaults to PH.

Supported Template

Template IDRegionRequired Parameters
tpl-blk002001PH (default)consent, mobileNumber, countryCode, templateId
blacklistTpl-f29e992a970f4dbbbf9df3cdfec4cd4e (deprecated)PH (default)consent, mobileNumber, countryCode, templateId

Field Rules

  • templateId is optional; if missing, the system uses tpl-blk002001.
  • countryCode is also optional; if omitted, it defaults to PH.
  • hitThreshold is optional; it sets the minimum number of matching records required to consider the subject a hit. It must be at least 1 and defaults to 3.

Sandbox Test Values

ParameterValueExpected Response
mobileNumber639559991234
countryCodePHresultCode = SUCCESS, hit = true

For all other valid mobile number and country code combinations, the response will return:
resultCode = SUCCESS, but hit = false.

post/alpha/blacklists

Request

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

Request body

OR

Example request

{
  "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"
  }
}

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": {
    "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 new optional request property ////

    • info

      added the new optional request property ////

    • 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

      added to the ///// request property allOf list

    • breaking

      added to the ///// request property allOf list

    • breaking

      the ///// request property type changed from string to no type, and format from date-time to no format

    • breaking

      the ///// request property type changed from string to no type, and format from date-time to no format

    • 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