v1

latestOpenAPI 3.0.12026-07-26105162235.7 KB

Envio

OTP

Envia uma senha OTP para um contato no WhatsApp. OTP = One time password. O campo Code é opcional; se não informado, será gerado um código de 5 dígitos aleatórios. O campo SenderId pode ser usado para controle do seu sistema. O CallbackUrl permite receber webhook quando a mensagem for entregue ou falhar. Este endpoint tem rate limit individual e permite 1000 requisições a cada 2 minutos.

post/v1/send/otp

Request body

codestring nullable

Código a ser enviado. Caso não seja informado, um código aleatório será gerado.

templateIdstring nullable

ID do modelo de mensagem do tipo Autenticação

fromstring required

Número do canal cadastrado na conta.

tostring required

Número de telefone do destinatário.

callbackUrlstring nullable

URL para receber webhook quando a mensagem for entregue ou falhar

senderIdstring nullable

ID de identificação no seu sistema para rastreamento e consulta da mensagem.

Response

Success

idstring uuid

createdAtstring date-time

updatedAtstring date-time

codestring nullable

status'UNDEFINED' | 'PENDING' | 'SENT' | 'RECEIVED' | 'FAILED'

fromstring nullable

templateIdstring nullable

companyIdstring uuid

senderIdstring nullable

channelIdstring uuid nullable

sentAtstring date-time nullable

receivedAtstring date-time nullable

contactPhoneNumberstring nullable

failedReasonstring nullable

callbackUrlstring nullable

statusUrlstring nullable