Contrato histórico: POST sms-twilio-auth

Contrato histórico de API. Esta página describe un contrato anterior. Los métodos, las rutas y las respuestas pueden diferir de la API vigente.

Significado histórico

Autenticación por SMS de Twilio

Este endpoint de la API se utiliza para autenticar después de recibir el código por SMS

API vigente

Para desarrollar una integración nueva, consulta la referencia o guía vigente enlazada.

Ver la referencia de la API vigente

Parámetros

[
  {
    "name": "api_version",
    "in": "path",
    "schema": {
      "type": "string",
      "default": "v400"
    },
    "required": true
  },
  {
    "name": "language",
    "in": "path",
    "schema": {
      "type": "string",
      "default": "en"
    },
    "required": true
  },
  {
    "name": "project",
    "in": "path",
    "schema": {
      "type": "string",
      "default": "<redacted-personal>"
    },
    "required": true
  }
]

Cuerpo de solicitud

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "El código recibido por SMS"
          },
          "cellphone": {
            "type": "string",
            "description": "El número de teléfono celular"
          },
          "country_phone_code": {
            "type": "integer",
            "description": "El código de país del número de teléfono celular",
            "format": "int32"
          }
        }
      }
    }
  }
}

Respuestas

{
  "200": {
    "description": "200",
    "content": {
      "application/json": {
        "examples": {
          "Result": {
            "value": "{\n  \"error\": false,\n  \"result\": {\n    \"id\": 1,\n    \"name\": \"<redacted-personal>\",\n    \"lastname\": \"Admin\",\n    \"email\": \"<redacted-email>\",\n    \"login_type\": 0,\n    \"social_id\": null,\n    \"photo\": null,\n    \"birthdate\": null,\n    \"phone\": \"<redacted-personal>\",\n    \"cellphone\": \"<redacted-personal>\",\n    \"city_id\": 1,\n    \"dropdown_option_id\": 0,\n    \"address\": \"<redacted-personal>\",\n    \"address_notes\": \"<redacted-personal>\",\n    \"zipcode\": \"10001\",\n    \"location\": {\n      \"lat\": 0,\n      \"lng\": 0\n    },\n    \"level\": 0,\n    \"language_id\": 1,\n    \"push_notifications\": true,\n    \"busy\": false,\n    \"available\": false,\n    \"enabled\": true,\n    \"created_at\": \"2018-10-06 18:18:24\",\n    \"updated_at\": \"2018-10-08 17:01:01\",\n    \"deleted_at\": null,\n    \"session\": {\n      \"access_token\": \"<redacted-secret>\",\n      \"token_type\": \"<redacted-secret>\",\n      \"expires_in\": 31536000\n    },\n    \"dropdown_option\": null\n  }\n}"
          }
        },
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "boolean",
              "example": false,
              "default": true
            },
            "result": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "example": 1,
                  "default": 0
                },
                "name": {
                  "type": "string",
                  "example": "<redacted-personal>"
                },
                "lastname": {
                  "type": "string",
                  "example": "Admin"
                },
                "email": {
                  "type": "string",
                  "example": "<redacted-email>"
                },
                "login_type": {
                  "type": "integer",
                  "example": 0,
                  "default": 0
                },
                "social_id": {},
                "photo": {},
                "birthdate": {},
                "phone": {
                  "type": "string",
                  "example": "<redacted-personal>"
                },
                "cellphone": {
                  "type": "string",
                  "example": "<redacted-personal>"
                },
                "city_id": {
                  "type": "integer",
                  "example": 1,
                  "default": 0
                },
                "dropdown_option_id": {
                  "type": "integer",
                  "example": 0,
                  "default": 0
                },
                "address": {
                  "type": "string",
                  "example": "<redacted-personal>"
                },
                "address_notes": {
                  "type": "string",
                  "example": "<redacted-personal>"
                },
                "zipcode": {
                  "type": "string",
                  "example": "10001"
                },
                "location": {
                  "type": "object",
                  "properties": {
                    "lat": {
                      "type": "number",
                      "example": 0,
                      "default": 0
                    },
                    "lng": {
                      "type": "number",
                      "example": 0,
                      "default": 0
                    }
                  }
                },
                "level": {
                  "type": "integer",
                  "example": 0,
                  "default": 0
                },
                "language_id": {
                  "type": "integer",
                  "example": 1,
                  "default": 0
                },
                "push_notifications": {
                  "type": "boolean",
                  "example": true,
                  "default": true
                },
                "busy": {
                  "type": "boolean",
                  "example": false,
                  "default": true
                },
                "available": {
                  "type": "boolean",
                  "example": false,
                  "default": true
                },
                "enabled": {
                  "type": "boolean",
                  "example": true,
                  "default": true
                },
                "created_at": {
                  "type": "string",
                  "example": "2018-10-06 18:18:24"
                },
                "updated_at": {
                  "type": "string",
                  "example": "2018-10-08 17:01:01"
                },
                "deleted_at": {},
                "session": {
                  "type": "object",
                  "properties": {
                    "access_token": {
                      "type": "string",
                      "example": "<redacted-secret>"
                    },
                    "token_type": {
                      "type": "string",
                      "example": "<redacted-secret>"
                    },
                    "expires_in": {
                      "type": "integer",
                      "example": 31536000,
                      "default": 0
                    }
                  }
                },
                "dropdown_option": {}
              }
            }
          }
        }
      }
    }
  },
  "400": {
    "description": "400",
    "content": {
      "application/json": {
        "examples": {
          "Result": {
            "value": "{}"
          }
        },
        "schema": {
          "type": "object",
          "properties": {}
        }
      }
    }
  }
}