Envio

OTP status

Consulta o status atual de uma mensagem OTP enviada anteriormente. O parâmetro id aceita o ID da mensagem ou o SenderId informado no envio. Este endpoint tem rate limit individual e permite 1000 requisições a cada 2 minutos.

get/v1/send/otp/{id}

Request

  • Base URL: https://api.helena.run/core
  • URL: https://api.helena.run/core/v1/send/otp/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

ID da mensagem ou SenderId para consultar o status.

Response

Success

idstring uuid
createdAtstring date-time
updatedAtstring date-time
codestring nullable
status'UNDEFINED' | 'PENDING' | 'SENT' | 'RECEIVED' | 'FAILED'
templateIdstring uuid
companyIdstring uuid
senderIdstring nullable
channelIdstring uuid nullable
sentAtstring date-time nullable
receivedAtstring date-time nullable
contactPhoneNumberstring nullable
statusUrlstring nullable
failedReasonstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.