SMsmileapi
Signals (Beta)

List Signals

Changed on

List all Signals.

get/beta/signals

Request

  • Base URL
    https://sandbox.smileapi.io/v1
  • URL
    https://sandbox.smileapi.io/v1/beta/signals
  • 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.

signalIdstring

Filter Signal Requests by a specific Signal Request ID.

signalType'Signal1' | 'Signal2' | 'Signal3'

Indicates which API variant handled the request.

Filter Signal Requests by a specific Signal Type.

phonestring

Filter Signal Requests by a specific mobile phone.

startDatestring date

Filter Signal Requests by request date, start of date range (YYYY-MM-DD)

endDatestring date

Filter Signal Requests by request date, end of date 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": {
          "fullName": "John Doe",
          "phone": "529559991234",
          "curp": "DOEJ800101HDFXXX01",
          "templateId": "tpl-sgn003002",
          "consent": {
            "type": "Terms and Conditions",
            "version": "1.0.0",
            "consentedAt": "2021-04-14T09:30:24Z",
            "consentedWith": "I agree to the terms and conditions"
          }
        }
      }
    ]
  }
}

Changes

  • 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

    • 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

    • 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

    • 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

    • 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

  • v1541c004ba4b3Revision changes
    • info

      added the new optional query request parameter signalType