SMsmileapi
Signals (Beta)

View Signal

Changed on

View Signal by unique ID.

get/beta/signals/{id}

Request

  • Base URL
    https://sandbox.smileapi.io/v1
  • URL
    https://sandbox.smileapi.io/v1/beta/signals/{id}
  • Auth
    HTTP basic

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

  • v13f330909f6b8Revision changes
    • breaking

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

    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added discriminator to / response property for the response status